`.
### Tag: package-2022-02 and go
diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md
index 5b1a0456c938..a47c94595444 100644
--- a/specification/azure-kusto/resource-manager/readme.md
+++ b/specification/azure-kusto/resource-manager/readme.md
@@ -28,15 +28,30 @@ These are the global settings for the Kusto API.
title: KustoManagementClient
description: 'The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.'
openapi-type: arm
-tag: package-2022-07
+tag: package-2022-12
```
+### Tag: package-2022-12
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.Kusto/stable/2022-12-29/kusto.json
+```
+### Tag: package-2022-11
+
+These settings apply only when `--tag=package-2022-11` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-11'
+input-file:
+ - Microsoft.Kusto/stable/2022-11-11/kusto.json
+```
### Tag: package-2022-07
These settings apply only when `--tag=package-2022-07` is specified on the command line.
-```yaml $(tag) == 'package-2022-07'
+``` yaml $(tag) == 'package-2022-07'
input-file:
- Microsoft.Kusto/stable/2022-07-07/kusto.json
```
diff --git a/specification/azure-kusto/resource-manager/readme.test.md b/specification/azure-kusto/resource-manager/readme.test.md
new file mode 100644
index 000000000000..8bf0bdf5229c
--- /dev/null
+++ b/specification/azure-kusto/resource-manager/readme.test.md
@@ -0,0 +1,8 @@
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-12'
+test-resources:
+ - Microsoft.Kusto/stable/2022-12-29/scenarios/basic.yaml
+```
\ No newline at end of file
diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/activeDirectoryConnectors.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/activeDirectoryConnectors.json
new file mode 100644
index 000000000000..80ea51423009
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/activeDirectoryConnectors.json
@@ -0,0 +1,242 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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": {
+ "type": "object"
+ }
+ }
+ },
+ "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/2022-06-15-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/azurearcdata.json
new file mode 100644
index 000000000000..7b11df672b2c
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/azurearcdata.json
@@ -0,0 +1,1450 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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.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.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.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.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.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.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.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates a sql Instance tags.": {
+ "$ref": "./examples/UpdateSqlManagedInstance.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.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.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.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.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.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"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "./common.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates a SQL Server Instance tags.": {
+ "$ref": "./examples/UpdateSqlServerInstance.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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"
+ },
+ "sqlServerInstanceName": {
+ "name": "sqlServerInstanceName",
+ "description": "Name of SQL Server Instance",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "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/2022-06-15-preview/common.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/common.json
new file mode 100644
index 000000000000..817b4a144d6c
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/common.json
@@ -0,0 +1,146 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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"
+ ]
+ },
+ "ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorResponseBody",
+ "description": "null"
+ }
+ },
+ "description": "An error response from the Azure Data on Azure Arc service."
+ },
+ "ErrorResponseBody": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorResponseBody"
+ },
+ "x-ms-identifiers": [
+ "message",
+ "target"
+ ],
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the Batch service."
+ },
+ "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
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/dataControllers.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/dataControllers.json
new file mode 100644
index 000000000000..9f92f28ea555
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/dataControllers.json
@@ -0,0 +1,253 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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/2022-06-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json
new file mode 100644
index 000000000000..87a6a7cf2526
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json
@@ -0,0 +1,134 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "activeDirectoryConnectorName": "testADConnector",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json
new file mode 100644
index 000000000000..3244f7ededd8
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testSqlServerInstance",
+ "databaseName": "testdb",
+ "api-version": "2022-06-15-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.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"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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/2022-06-15-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateDataController.json
new file mode 100644
index 000000000000..3c24f7340db4
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateDataController.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdatePostgresInstance.json
new file mode 100644
index 000000000000..6ea1fe7d4ccd
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdatePostgresInstance.json
@@ -0,0 +1,172 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "postgresInstanceName": "testpostgresInstance",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateSqlManagedInstance.json
new file mode 100644
index 000000000000..bb7177d9701d
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateSqlManagedInstance.json
@@ -0,0 +1,192 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlManagedInstanceName": "testsqlManagedInstance",
+ "api-version": "2022-06-15-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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateSqlServerInstance.json
new file mode 100644
index 000000000000..03e078f7e8b7
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/CreateOrUpdateSqlServerInstance.json
@@ -0,0 +1,112 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2022-06-15-preview",
+ "sqlServerInstance": {
+ "location": "northeurope",
+ "tags": {
+ "mytag": "myval"
+ },
+ "properties": {
+ "version": "SQL Server 2012",
+ "edition": "Developer",
+ "containerResourceId": "Resource id of hosting Arc Machine",
+ "vCore": "4",
+ "cores": "4",
+ "patchLevel": "patchlevel",
+ "collation": "collation",
+ "currentVersion": "2012",
+ "instanceName": "name of instance",
+ "tcpDynamicPorts": "1433",
+ "tcpStaticPorts": "1433",
+ "productId": "sql id",
+ "licenseType": "Free",
+ "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z",
+ "status": "Registered",
+ "azureDefenderStatus": "Protected",
+ "hostType": "Physical Server"
+ }
+ }
+ },
+ "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",
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "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/2022-06-15-preview/examples/DeleteActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteActiveDirectoryConnector.json
new file mode 100644
index 000000000000..e8c85b0d54c0
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteActiveDirectoryConnector.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "activeDirectoryConnectorName": "testADConnector",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/DeleteArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteArcSqlServerDatabase.json
new file mode 100644
index 000000000000..780b96e5e2fd
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteArcSqlServerDatabase.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlManagedInstance",
+ "databaseName": "testdb",
+ "api-version": "2022-06-15-preview"
+ },
+ "responses": {
+ "200": {
+ "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/2022-06-15-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteDataController.json
new file mode 100644
index 000000000000..d4d693901add
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteDataController.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeletePostgresInstance.json
new file mode 100644
index 000000000000..a06c7ccfa191
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeletePostgresInstance.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "postgresInstanceName": "testpostgresInstance",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteSqlManagedInstance.json
new file mode 100644
index 000000000000..5ffce080d907
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteSqlManagedInstance.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlManagedInstanceName": "testsqlManagedInstance",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteSqlServerInstance.json
new file mode 100644
index 000000000000..33a419456c1b
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/DeleteSqlServerInstance.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/GetActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetActiveDirectoryConnector.json
new file mode 100644
index 000000000000..60d2d4b6ebfe
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetActiveDirectoryConnector.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "activeDirectoryConnectorName": "testADConnector",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/GetArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetArcSqlServerDatabase.json
new file mode 100644
index 000000000000..bc1358d1f049
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetArcSqlServerDatabase.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testSqlServerInstance",
+ "databaseName": "testdb",
+ "api-version": "2022-06-15-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"
+ }
+ },
+ "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/2022-06-15-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetDataController.json
new file mode 100644
index 000000000000..5ee53426fb4e
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetDataController.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetPostgresInstance.json
new file mode 100644
index 000000000000..2978dfec9a59
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetPostgresInstance.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "postgresInstanceName": "testpostgresInstances",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetSqlManagedInstance.json
new file mode 100644
index 000000000000..46c20845b475
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetSqlManagedInstance.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlManagedInstanceName": "testsqlManagedInstance",
+ "api-version": "2022-06-15-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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetSqlServerInstance.json
new file mode 100644
index 000000000000..9c103772ec46
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/GetSqlServerInstance.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2022-06-15-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",
+ "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"
+ },
+ "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/2022-06-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json
new file mode 100644
index 000000000000..7b8a2224e1e1
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json
@@ -0,0 +1,104 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupDataController.json
new file mode 100644
index 000000000000..d1de89bab1fb
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupDataController.json
@@ -0,0 +1,115 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupPostgresInstance.json
new file mode 100644
index 000000000000..9f2945f68790
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupPostgresInstance.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupSqlManagedInstance.json
new file mode 100644
index 000000000000..a4075a3f47b1
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupSqlManagedInstance.json
@@ -0,0 +1,137 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2022-06-15-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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupSqlServerInstance.json
new file mode 100644
index 000000000000..1ac135ee3662
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListByResourceGroupSqlServerInstance.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "api-version": "2022-06-15-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",
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "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/2022-06-15-preview/examples/ListBySqlServerInstanceDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListBySqlServerInstanceDatabase.json
new file mode 100644
index 000000000000..44ee325155b6
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListBySqlServerInstanceDatabase.json
@@ -0,0 +1,98 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testSqlServerInstance",
+ "api-version": "2022-06-15-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"
+ }
+ },
+ "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"
+ }
+ },
+ "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/2022-06-15-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListOperation.json
new file mode 100644
index 000000000000..9a4ab4e4c278
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListOperation.json
@@ -0,0 +1,353 @@
+{
+ "parameters": {
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionDataController.json
new file mode 100644
index 000000000000..3b1738c358c8
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionDataController.json
@@ -0,0 +1,119 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionPostgresInstance.json
new file mode 100644
index 000000000000..49039f4184a8
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionPostgresInstance.json
@@ -0,0 +1,76 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionSqlManagedInstance.json
new file mode 100644
index 000000000000..90d8529f53bf
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionSqlManagedInstance.json
@@ -0,0 +1,138 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2022-06-15-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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionSqlServerInstance.json
new file mode 100644
index 000000000000..3283b6fccf09
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/ListSubscriptionSqlServerInstance.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "api-version": "2022-06-15-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",
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "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/2022-06-15-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateDataController.json
new file mode 100644
index 000000000000..417cb631c7e4
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateDataController.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "dataControllerName": "testdataController1",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdatePostgresInstance.json
new file mode 100644
index 000000000000..a53eaf3f4196
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdatePostgresInstance.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "postgresInstanceName": "testpostgresInstance",
+ "api-version": "2022-06-15-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/2022-06-15-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlManagedInstance.json
new file mode 100644
index 000000000000..772c435a3f7f
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlManagedInstance.json
@@ -0,0 +1,76 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlManagedInstanceName": "testsqlManagedInstance",
+ "api-version": "2022-06-15-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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/examples/UpdateSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlServerDatabase.json
new file mode 100644
index 000000000000..85963a12401b
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlServerDatabase.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlManagedInstance",
+ "api-version": "2022-06-15-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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlServerInstance.json
new file mode 100644
index 000000000000..9092bc7d980d
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/examples/UpdateSqlServerInstance.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-1111-2222-3333-444444444444",
+ "resourceGroupName": "testrg",
+ "sqlServerInstanceName": "testsqlServerInstance",
+ "api-version": "2022-06-15-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",
+ "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"
+ },
+ "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/2022-06-15-preview/operations.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/operations.json
new file mode 100644
index 000000000000..0cf608737c75
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/operations.json
@@ -0,0 +1,127 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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": {
+ "type": "object"
+ },
+ "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/2022-06-15-preview/postgresInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/postgresInstances.json
new file mode 100644
index 000000000000..f42b3b33eba4
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/postgresInstances.json
@@ -0,0 +1,174 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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/2022-06-15-preview/sqlManagedInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlManagedInstances.json
new file mode 100644
index 000000000000..877177b0b486
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlManagedInstances.json
@@ -0,0 +1,309 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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": {
+ "type": "object"
+ }
+ },
+ "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'."
+ }
+ },
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "K8sScheduling": {
+ "type": "object",
+ "description": "The kubernetes scheduling information.",
+ "properties": {
+ "default": {
+ "$ref": "#/definitions/K8sSchedulingOptions"
+ }
+ },
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "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": {
+ "type": "object"
+ }
+ },
+ "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": {
+ "type": "object"
+ }
+ },
+ "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/2022-06-15-preview/sqlServerDatabases.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerDatabases.json
new file mode 100644
index 000000000000..d069e60b8472
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerDatabases.json
@@ -0,0 +1,490 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "./common.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": {
+ "200": {
+ "description": "Successfully deleted the database."
+ },
+ "204": {
+ "description": "The specified database does not exist."
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "./common.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Deletes a database resource": {
+ "$ref": "./examples/DeleteArcSqlServerDatabase.json"
+ }
+ }
+ },
+ "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.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"
+ }
+ },
+ "default": {
+ "description": "*** Error Responses: ***",
+ "schema": {
+ "$ref": "./common.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update a database.": {
+ "$ref": "./examples/UpdateSqlServerDatabase.json"
+ }
+ }
+ }
+ },
+ "/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.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"
+ }
+ }
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "The provisioning state of the Arc-enabled SQL Server database resource.",
+ "readOnly": true
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "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/2022-06-15-preview/sqlServerInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerInstances.json
new file mode 100644
index 000000000000..835f06ce6df1
--- /dev/null
+++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerInstances.json
@@ -0,0 +1,245 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-06-15-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"
+ ],
+ "x-ms-enum": {
+ "name": "editionType",
+ "modelAsString": true
+ }
+ },
+ "containerResourceId": {
+ "type": "string",
+ "description": "ARM Resource id of the container resource (Azure Arc for Servers)."
+ },
+ "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."
+ },
+ "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.",
+ "enum": [
+ "Connected",
+ "Disconnected",
+ "Registered",
+ "Unknown"
+ ],
+ "x-ms-enum": {
+ "name": "ConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "patchLevel": {
+ "type": "string",
+ "description": "SQL Server update level."
+ },
+ "collation": {
+ "type": "string",
+ "description": "SQL Server collation."
+ },
+ "currentVersion": {
+ "type": "string",
+ "description": "SQL Server current version."
+ },
+ "instanceName": {
+ "type": "string",
+ "description": "SQL Server instance name."
+ },
+ "tcpDynamicPorts": {
+ "type": "string",
+ "description": "Dynamic TCP ports used by SQL Server."
+ },
+ "tcpStaticPorts": {
+ "type": "string",
+ "description": "Static TCP ports used by SQL Server."
+ },
+ "productId": {
+ "type": "string",
+ "description": "SQL Server product ID."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "SQL Server license type.",
+ "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."
+ },
+ "azureDefenderStatus": {
+ "type": "string",
+ "description": "Status of Azure Defender.",
+ "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
+ },
+ "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
+ }
+ }
+ },
+ "required": [
+ "containerResourceId",
+ "status"
+ ]
+ },
+ "SqlServerInstanceUpdate": {
+ "description": "An update to a SQL Server Instance.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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
+ }
+ }
+ }
+ },
+ "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 15fd8ec20769..c3052f321c25 100644
--- a/specification/azurearcdata/resource-manager/readme.md
+++ b/specification/azurearcdata/resource-manager/readme.md
@@ -27,10 +27,26 @@ These are the global settings for the azurearcdata.
``` yaml
openapi-type: arm
openapi-subtype: rpaas
-tag: package-preview-2022-03
+tag: package-preview-2022-06
```
+### Tag: package-preview-2022-06
+
+These settings apply only when `--tag=package-preview-2022-06` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2022-06'
+input-file:
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/activeDirectoryConnectors.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/azurearcdata.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/common.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/dataControllers.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/operations.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/postgresInstances.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/sqlManagedInstances.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerInstances.json
+ - Microsoft.AzureArcData/preview/2022-06-15-preview/sqlServerDatabases.json
+```
### Tag: package-preview-2022-03
These settings apply only when `--tag=package-preview-2022-03` is specified on the command line.
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/arcSettings.json
new file mode 100644
index 000000000000..2377752a299c
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/arcSettings.json
@@ -0,0 +1,656 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings": {
+ "get": {
+ "operationId": "ArcSettings_ListByCluster",
+ "description": "Get ArcSetting resources of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ArcSettingList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List ArcSetting resources by HCI Cluster": {
+ "$ref": "./examples/ListArcSettingsByCluster.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": {
+ "get": {
+ "operationId": "ArcSettings_Get",
+ "description": "Get ArcSetting resource details of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ArcSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ArcSetting": {
+ "$ref": "./examples/GetArcSetting.json"
+ }
+ }
+ },
+ "put": {
+ "operationId": "ArcSettings_Create",
+ "description": "Create ArcSetting for HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "name": "arcSetting",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ArcSetting"
+ },
+ "description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ArcSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create ArcSetting": {
+ "$ref": "./examples/PutArcSetting.json"
+ }
+ }
+ },
+ "patch": {
+ "operationId": "ArcSettings_Update",
+ "description": "Update ArcSettings for HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "name": "arcSetting",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ArcSettingsPatch"
+ },
+ "description": "ArcSettings parameters that needs to be updated"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ArcSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch ArcSetting": {
+ "$ref": "./examples/PatchArcSetting.json"
+ }
+ }
+ },
+ "delete": {
+ "operationId": "ArcSettings_Delete",
+ "description": "Delete ArcSetting resource details of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Delete ArcSetting": {
+ "$ref": "./examples/DeleteArcSetting.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword": {
+ "post": {
+ "tags": [
+ "ArcSettings"
+ ],
+ "operationId": "ArcSettings_GeneratePassword",
+ "description": "Generate password for arc settings.",
+ "x-ms-examples": {
+ "Generate Password": {
+ "$ref": "./examples/GeneratePassword.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PasswordCredential"
+ }
+ },
+ "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity": {
+ "post": {
+ "tags": [
+ "ArcSettings"
+ ],
+ "operationId": "ArcSettings_CreateIdentity",
+ "description": "Create Aad identity for arc settings.",
+ "x-ms-examples": {
+ "Create Arc Identity": {
+ "$ref": "./examples/CreateArcIdentity.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ArcIdentityResponse"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ArcSettingList": {
+ "description": "List of ArcSetting proxy resources for the HCI cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of ArcSetting proxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ArcSetting"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ArcSettingsPatch": {
+ "description": "ArcSetting details to update.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "description": "ArcSettings properties.",
+ "$ref": "#/definitions/ArcSettingsPatchProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ArcSettingsPatchProperties": {
+ "description": "ArcSettings properties.",
+ "type": "object",
+ "properties": {
+ "connectivityProperties": {
+ "description": "contains connectivity related configuration for ARC resources",
+ "type": "object",
+ "items": {
+ "$ref": "#/definitions/ArcConnectivityProperties"
+ }
+ }
+ }
+ },
+ "ArcSetting": {
+ "description": "ArcSetting details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ArcSetting properties.",
+ "$ref": "#/definitions/ArcSettingProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ArcSettingProperties": {
+ "description": "ArcSetting properties.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the ArcSetting proxy resource.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning",
+ "DisableInProgress"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "arcInstanceResourceGroup": {
+ "description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.",
+ "type": "string"
+ },
+ "arcApplicationClientId": {
+ "description": "App id of arc AAD identity.",
+ "type": "string"
+ },
+ "arcApplicationTenantId": {
+ "description": "Tenant id of arc AAD identity.",
+ "type": "string"
+ },
+ "arcServicePrincipalObjectId": {
+ "description": "Object id of arc AAD service principal.",
+ "type": "string"
+ },
+ "arcApplicationObjectId": {
+ "description": "Object id of arc AAD identity.",
+ "type": "string"
+ },
+ "aggregateState": {
+ "description": "Aggregate state of Arc agent across the nodes in this HCI cluster.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Canceled",
+ "Failed",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning",
+ "DisableInProgress"
+ ],
+ "x-ms-enum": {
+ "name": "ArcSettingAggregateState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "perNodeDetails": {
+ "description": "State of Arc agent in each of the nodes.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PerNodeState"
+ },
+ "readOnly": true
+ },
+ "connectivityProperties": {
+ "description": "contains connectivity related configuration for ARC resources",
+ "type": "object",
+ "items": {
+ "$ref": "#/definitions/ArcConnectivityProperties"
+ }
+ }
+ }
+ },
+ "PerNodeState": {
+ "description": "Status of Arc agent for a particular node in HCI Cluster.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Name of the Node in HCI Cluster"
+ },
+ "arcInstance": {
+ "description": "Fully qualified resource ID for the Arc agent of this node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "state": {
+ "description": "State of Arc agent in this node.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Canceled",
+ "Failed",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning",
+ "DisableInProgress"
+ ],
+ "x-ms-enum": {
+ "name": "NodeArcState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ArcConnectivityProperties": {
+ "description": "Connectivity related configuration required by arc server.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "True indicates ARC connectivity is enabled"
+ }
+ },
+ "additionalProperties": false
+ },
+ "PasswordCredential": {
+ "type": "object",
+ "properties": {
+ "secretText": {
+ "type": "string"
+ },
+ "keyId": {
+ "type": "string"
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ "additionalProperties": false,
+ "readOnly": true
+ },
+ "ArcIdentityResponse": {
+ "description": "ArcIdentity details.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "ArcIdentity properties.",
+ "$ref": "#/definitions/ArcIdentityResponseProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ArcIdentityResponseProperties": {
+ "type": "object",
+ "properties": {
+ "arcApplicationClientId": {
+ "type": "string"
+ },
+ "arcApplicationTenantId": {
+ "type": "string"
+ },
+ "arcServicePrincipalObjectId": {
+ "type": "string"
+ },
+ "arcApplicationObjectId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "readOnly": true
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "ArcSettingNameParameter": {
+ "name": "arcSettingName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proxy resource holding details of HCI ArcSetting information.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/clusters.json
new file mode 100644
index 000000000000..2dd7fa7a1d7e
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/clusters.json
@@ -0,0 +1,986 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_ListBySubscription",
+ "x-ms-examples": {
+ "List clusters in a given subscription": {
+ "$ref": "./examples/ListClustersBySubscription.json"
+ }
+ },
+ "description": "List all HCI clusters in a subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClusterList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_ListByResourceGroup",
+ "x-ms-examples": {
+ "List clusters in a given resource group": {
+ "$ref": "./examples/ListClustersByResourceGroup.json"
+ }
+ },
+ "description": "List all HCI clusters in a resource group.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClusterList"
+ }
+ },
+ "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.AzureStackHCI/clusters/{clusterName}": {
+ "get": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Get",
+ "x-ms-examples": {
+ "Get cluster": {
+ "$ref": "./examples/GetCluster.json"
+ }
+ },
+ "description": "Get HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Create",
+ "x-ms-examples": {
+ "Create cluster": {
+ "$ref": "./examples/CreateCluster.json"
+ }
+ },
+ "description": "Create an HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "cluster",
+ "in": "body",
+ "description": "Details of the HCI cluster.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Update",
+ "x-ms-examples": {
+ "Update cluster": {
+ "$ref": "./examples/UpdateCluster.json"
+ }
+ },
+ "description": "Update an HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "cluster",
+ "in": "body",
+ "description": "Details of the HCI cluster.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ClusterPatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Clusters"
+ ],
+ "operationId": "Clusters_Delete",
+ "x-ms-examples": {
+ "Delete cluster": {
+ "$ref": "./examples/DeleteCluster.json"
+ }
+ },
+ "description": "Delete an HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate": {
+ "post": {
+ "tags": [
+ "Cluster"
+ ],
+ "operationId": "Clusters_UploadCertificate",
+ "x-ms-examples": {
+ "Upload certificate": {
+ "$ref": "./examples/UploadCertificate.json"
+ }
+ },
+ "description": "Upload certificate.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "uploadCertificateRequest",
+ "in": "body",
+ "description": "Upload certificate request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UploadCertificateRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity": {
+ "post": {
+ "tags": [
+ "Cluster"
+ ],
+ "operationId": "Clusters_CreateIdentity",
+ "description": "Create cluster identity.",
+ "x-ms-examples": {
+ "Create cluster Identity": {
+ "$ref": "./examples/CreateClusterIdentity.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClusterIdentityResponse"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit": {
+ "post": {
+ "tags": [
+ "Cluster"
+ ],
+ "operationId": "Clusters_ExtendSoftwareAssuranceBenefit",
+ "description": "Extends Software Assurance Benefit to a cluster",
+ "x-ms-examples": {
+ "Create cluster Identity": {
+ "$ref": "./examples/ExtendSoftwareAssuranceBenefit.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "softwareAssuranceChangeRequest",
+ "in": "body",
+ "description": "Software Assurance Change Request Payload",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SoftwareAssuranceChangeRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ClusterList": {
+ "description": "List of clusters.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of clusters.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Cluster"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Cluster": {
+ "description": "Cluster details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "description": "Identity of Cluster resource",
+ "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity",
+ "x-ms-client-flatten": true
+ },
+ "properties": {
+ "description": "Cluster properties.",
+ "$ref": "#/definitions/ClusterProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ClusterPatch": {
+ "description": "Cluster details to update.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "description": "Identity of Cluster resource",
+ "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity",
+ "x-ms-client-flatten": true
+ },
+ "properties": {
+ "description": "Cluster properties.",
+ "$ref": "#/definitions/ClusterPatchProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ClusterProperties": {
+ "description": "Cluster properties.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning",
+ "NotSpecified",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "Deleted",
+ "PartiallySucceeded",
+ "InProgress",
+ "DisableInProgress",
+ "Connected",
+ "PartiallyConnected",
+ "Disconnected"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "status": {
+ "description": "Status of the cluster agent.",
+ "type": "string",
+ "enum": [
+ "NotYetRegistered",
+ "ConnectedRecently",
+ "NotConnectedRecently",
+ "Disconnected",
+ "Error",
+ "NotSpecified"
+ ],
+ "x-ms-enum": {
+ "name": "Status",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "cloudId": {
+ "description": "Unique, immutable resource id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudManagementEndpoint": {
+ "description": "Endpoint configured for management from the Azure portal.",
+ "type": "string"
+ },
+ "aadClientId": {
+ "description": "App id of cluster AAD identity.",
+ "type": "string"
+ },
+ "aadTenantId": {
+ "description": "Tenant id of cluster AAD identity.",
+ "type": "string"
+ },
+ "aadApplicationObjectId": {
+ "description": "Object id of cluster AAD identity.",
+ "type": "string"
+ },
+ "aadServicePrincipalObjectId": {
+ "description": "Id of cluster identity service principal.",
+ "type": "string"
+ },
+ "softwareAssuranceProperties": {
+ "description": "Software Assurance properties of the cluster.",
+ "$ref": "#/definitions/SoftwareAssuranceProperties"
+ },
+ "desiredProperties": {
+ "description": "Desired properties of the cluster.",
+ "$ref": "#/definitions/ClusterDesiredProperties"
+ },
+ "reportedProperties": {
+ "description": "Properties reported by cluster agent.",
+ "$ref": "#/definitions/ClusterReportedProperties",
+ "readOnly": true
+ },
+ "trialDaysRemaining": {
+ "description": "Number of days remaining in the trial period.",
+ "type": "number",
+ "readOnly": true
+ },
+ "billingModel": {
+ "description": "Type of billing applied to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "registrationTimestamp": {
+ "description": "First cluster sync timestamp.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "lastSyncTimestamp": {
+ "description": "Most recent cluster sync timestamp.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "lastBillingTimestamp": {
+ "description": "Most recent billing meter timestamp.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "serviceEndpoint": {
+ "description": "Region specific DataPath Endpoint of the cluster.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resourceProviderObjectId": {
+ "description": "Object id of RP Service Principal",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ClusterPatchProperties": {
+ "description": "Cluster properties.",
+ "type": "object",
+ "properties": {
+ "cloudManagementEndpoint": {
+ "description": "Endpoint configured for management from the Azure portal",
+ "type": "string"
+ },
+ "aadClientId": {
+ "description": "App id of cluster AAD identity.",
+ "type": "string"
+ },
+ "aadTenantId": {
+ "description": "Tenant id of cluster AAD identity.",
+ "type": "string"
+ },
+ "desiredProperties": {
+ "description": "Desired properties of the cluster.",
+ "$ref": "#/definitions/ClusterDesiredProperties"
+ }
+ }
+ },
+ "SoftwareAssuranceProperties": {
+ "description": "Software Assurance properties of the cluster.",
+ "type": "object",
+ "properties": {
+ "softwareAssuranceStatus": {
+ "description": "Status of the Software Assurance for the cluster.",
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "SoftwareAssuranceStatus",
+ "modelAsString": true
+ }
+ },
+ "softwareAssuranceIntent": {
+ "description": "Customer Intent for Software Assurance Benefit.",
+ "type": "string",
+ "enum": [
+ "Enable",
+ "Disable"
+ ],
+ "x-ms-enum": {
+ "name": "SoftwareAssuranceIntent",
+ "modelAsString": true
+ }
+ },
+ "lastUpdated": {
+ "description": "TimeStamp denoting the latest SA benefit applicability is validated.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ }
+ }
+ },
+ "ClusterDesiredProperties": {
+ "description": "Desired properties of the cluster.",
+ "type": "object",
+ "properties": {
+ "windowsServerSubscription": {
+ "description": "Desired state of Windows Server Subscription.",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "WindowsServerSubscription",
+ "modelAsString": true
+ }
+ },
+ "diagnosticLevel": {
+ "description": "Desired level of diagnostic data emitted by the cluster.",
+ "type": "string",
+ "enum": [
+ "Off",
+ "Basic",
+ "Enhanced"
+ ],
+ "x-ms-enum": {
+ "name": "DiagnosticLevel",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ClusterReportedProperties": {
+ "description": "Properties reported by cluster agent.",
+ "type": "object",
+ "properties": {
+ "clusterName": {
+ "description": "Name of the on-prem cluster connected to this resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "clusterId": {
+ "description": "Unique id generated by the on-prem cluster.",
+ "type": "string",
+ "readOnly": true
+ },
+ "clusterVersion": {
+ "description": "Version of the cluster software.",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodes": {
+ "description": "List of nodes reported by the cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClusterNode"
+ },
+ "readOnly": true
+ },
+ "lastUpdated": {
+ "description": "Last time the cluster reported the data.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "imdsAttestation": {
+ "description": "IMDS attestation status of the cluster.",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "ImdsAttestation",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "diagnosticLevel": {
+ "description": "Level of diagnostic data emitted by the cluster.",
+ "type": "string",
+ "enum": [
+ "Off",
+ "Basic",
+ "Enhanced"
+ ],
+ "x-ms-enum": {
+ "name": "DiagnosticLevel",
+ "modelAsString": true
+ }
+ },
+ "supportedCapabilities": {
+ "description": "Capabilities supported by the cluster.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "ClusterNode": {
+ "description": "Cluster node details.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the cluster node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Id of the node in the cluster.",
+ "type": "number",
+ "readOnly": true
+ },
+ "windowsServerSubscription": {
+ "description": "State of Windows Server Subscription.",
+ "type": "string",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "x-ms-enum": {
+ "name": "WindowsServerSubscription",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "nodeType": {
+ "description": "Type of the cluster node hardware.",
+ "type": "string",
+ "enum": [
+ "FirstParty",
+ "ThirdParty"
+ ],
+ "x-ms-enum": {
+ "name": "ClusterNodeType",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "ehcResourceId": {
+ "description": "Edge Hardware Center Resource Id",
+ "type": "string",
+ "readOnly": true
+ },
+ "manufacturer": {
+ "description": "Manufacturer of the cluster node hardware.",
+ "type": "string",
+ "readOnly": true
+ },
+ "model": {
+ "description": "Model name of the cluster node hardware.",
+ "type": "string",
+ "readOnly": true
+ },
+ "osName": {
+ "description": "Operating system running on the cluster node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "osVersion": {
+ "description": "Version of the operating system running on the cluster node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "osDisplayVersion": {
+ "description": "Display version of the operating system running on the cluster node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Immutable id of the cluster node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "coreCount": {
+ "description": "Number of physical cores on the cluster node.",
+ "type": "number",
+ "readOnly": true
+ },
+ "memoryInGiB": {
+ "description": "Total available memory on the cluster node (in GiB).",
+ "type": "number",
+ "readOnly": true
+ }
+ }
+ },
+ "RawCertificateData": {
+ "type": "object",
+ "properties": {
+ "certificates": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "UploadCertificateRequest": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/RawCertificateData"
+ }
+ },
+ "additionalProperties": false
+ },
+ "SoftwareAssuranceChangeRequestProperties": {
+ "type": "object",
+ "properties": {
+ "softwareAssuranceIntent": {
+ "type": "string",
+ "enum": [
+ "Enable",
+ "Disable"
+ ],
+ "x-ms-enum": {
+ "name": "SoftwareAssuranceIntent",
+ "modelAsString": true
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "SoftwareAssuranceChangeRequest": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SoftwareAssuranceChangeRequestProperties"
+ }
+ },
+ "additionalProperties": false
+ },
+ "ClusterIdentityResponse": {
+ "description": "Cluster Identity details.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Cluster identity properties.",
+ "$ref": "#/definitions/ClusterIdentityResponseProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ClusterIdentityResponseProperties": {
+ "type": "object",
+ "properties": {
+ "aadClientId": {
+ "type": "string"
+ },
+ "aadTenantId": {
+ "type": "string"
+ },
+ "aadServicePrincipalObjectId": {
+ "type": "string"
+ },
+ "aadApplicationObjectId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "readOnly": true
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateArcIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateArcIdentity.json
new file mode 100644
index 000000000000..fd8b5bcc37a6
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateArcIdentity.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "arcApplicationClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba",
+ "arcApplicationTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b",
+ "arcApplicationObjectId": "400bd05f-395f-45a6-ba75-72601df80107",
+ "arcServicePrincipalObjectId": "00cc4014-482e-4de9-9932-83415cc75f45"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateCluster.json
new file mode 100644
index 000000000000..36c1b616ef35
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateCluster.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01",
+ "cluster": {
+ "location": "East US",
+ "properties": {
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster",
+ "name": "myCluster",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "identity": {
+ "principalId": "87a834db-2e45-409e-911b-e16a44562ec3",
+ "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "type": "SystemAssigned"
+ },
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {},
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateClusterIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateClusterIdentity.json
new file mode 100644
index 000000000000..448a41418f1f
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/CreateClusterIdentity.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "aadClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba",
+ "aadTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b",
+ "aadServicePrincipalObjectId": "400bd05f-395f-45a6-ba75-72601df80107",
+ "aadApplicationObjectId": "00cc4014-482e-4de9-9932-83415cc75f45"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteArcSetting.json
new file mode 100644
index 000000000000..010b6232f205
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteArcSetting.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteCluster.json
new file mode 100644
index 000000000000..1a6915c64312
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteCluster.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteExtension.json
new file mode 100644
index 000000000000..a7277d3b707d
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteExtension.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "extensionName": "MicrosoftMonitoringAgent",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateRuns.json
new file mode 100644
index 000000000000..64a470c8eb1e
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateRuns.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateSummaries.json
new file mode 100644
index 000000000000..89600501e64c
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdateSummaries.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdates.json
new file mode 100644
index 000000000000..1e58e5cc704e
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/DeleteUpdates.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ExtendSoftwareAssuranceBenefit.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ExtendSoftwareAssuranceBenefit.json
new file mode 100644
index 000000000000..af19e6dfcb13
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ExtendSoftwareAssuranceBenefit.json
@@ -0,0 +1,82 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01",
+ "softwareAssuranceChangeRequest": {
+ "properties": {
+ "softwareAssuranceIntent": "Enable"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster",
+ "name": "myCluster",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "softwareAssuranceProperties": {
+ "softwareAssuranceStatus": "Enabled",
+ "lastUpdated": "2022-08-18T22:01:12.4191603Z",
+ "softwareAssuranceIntent": "Enable"
+ },
+ "reportedProperties": {
+ "clusterName": "cluster1",
+ "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
+ "clusterVersion": "10.0.17777",
+ "nodes": [
+ {
+ "name": "Node1",
+ "id": 1,
+ "windowsServerSubscription": "Enabled",
+ "nodeType": "ThirdParty",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q45CZC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ }
+ ],
+ "lastUpdated": "2020-03-11T19:24:42.1946017Z",
+ "imdsAttestation": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GeneratePassword.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GeneratePassword.json
new file mode 100644
index 000000000000..47eae57ef04f
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GeneratePassword.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "secretText": "secretText",
+ "startDateTime": "2022-02-17T16:24:23.6264005+05:30",
+ "endDateTime": "2121-02-17T16:24:23.6264377+05:30",
+ "keyId": "00000000-2d47-4fb2-8ed2-fed71a5c197b"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetArcSetting.json
new file mode 100644
index 000000000000..f103be02dd3b
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetArcSetting.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "arcInstanceResourceGroup": "ArcInstance-rg",
+ "aggregateState": "PartiallyConnected",
+ "perNodeDetails": [
+ {
+ "name": "Node-1",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
+ "state": "Connected"
+ },
+ {
+ "name": "Node-2",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2",
+ "state": "Disconnected"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetCluster.json
new file mode 100644
index 000000000000..eda0a211f2f5
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetCluster.json
@@ -0,0 +1,90 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster",
+ "name": "myCluster",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {
+ "clusterName": "cluster1",
+ "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
+ "clusterVersion": "10.0.17777",
+ "nodes": [
+ {
+ "name": "Node1",
+ "id": 1,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q45CZC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node2",
+ "id": 2,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44BSC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node3",
+ "id": 3,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44RFC3",
+ "coreCount": 16,
+ "memoryInGiB": 256
+ }
+ ],
+ "lastUpdated": "2020-03-11T19:24:42.1946017Z",
+ "imdsAttestation": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetExtension.json
new file mode 100644
index 000000000000..8ec4e66012a1
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetExtension.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "extensionName": "MicrosoftMonitoringAgent",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
+ "name": "MicrosoftMonitoringAgent",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "workspaceId": "xx"
+ }
+ },
+ "aggregateState": "PartiallySucceeded",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
+ "state": "Succeeded"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
+ "state": "Failed"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetOffer.json
new file mode 100644
index 000000000000..6e9f63b97111
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetOffer.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "publisherName": "publisher1",
+ "offerName": "offer1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers/offers",
+ "name": "offer1",
+ "properties": {
+ "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.
\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}",
+ "contentVersion": "2018-01-01",
+ "publisherId": "publisher1",
+ "provisioningState": "Succeeded",
+ "skuMappings": [
+ {
+ "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm",
+ "marketplaceSkuId": "enterprise",
+ "marketplaceSkuVersions": [
+ "15.0.220208"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetPublisher.json
new file mode 100644
index 000000000000..75b6a4bfbf7f
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetPublisher.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "publisherName": "publisher1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers",
+ "name": "publisher1"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetSku.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetSku.json
new file mode 100644
index 000000000000..8653554606df
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetSku.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "publisherName": "publisher1",
+ "offerName": "offer1",
+ "skuName": "sku1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus",
+ "name": "sku1",
+ "properties": {
+ "publisherId": "publisher1",
+ "offerId": "offer1",
+ "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.
\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}",
+ "contentVersion": "2018-01-01",
+ "provisioningState": "Succeeded",
+ "skuMappings": [
+ {
+ "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm",
+ "marketplaceSkuId": "enterprise",
+ "marketplaceSkuVersions": [
+ "15.0.220208"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateRuns.json
new file mode 100644
index 000000000000..61429a8cde52
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateRuns.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "type": "Microsoft.AzureStackHCI/updates/updateRuns",
+ "location": "West US",
+ "properties": {
+ "progress": {
+ "name": "Unnamed step",
+ "description": "Update Azure Stack.",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "steps": [
+ {
+ "name": "PreUpdate Cloud",
+ "description": "Prepare for SSU update",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "steps": []
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateSummaries.json
new file mode 100644
index 000000000000..9c4cd092ff4f
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdateSummaries.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default",
+ "name": "default",
+ "type": "Microsoft.AzureStackHCI/updateSummaries",
+ "location": "West US",
+ "properties": {
+ "oemFamily": "DellEMC",
+ "hardwareModel": "PowerEdge R730xd",
+ "packageVersions": [
+ {
+ "packageType": "OEM",
+ "version": "2.2.2108.6",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Services",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Infrastructure",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ }
+ ],
+ "currentVersion": "4.2203.2.32",
+ "state": "AppliedSuccessfully"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdates.json
new file mode 100644
index 000000000000..4880fdb07dd0
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/GetUpdates.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32",
+ "name": "Microsoft4.2203.2.32",
+ "type": "Microsoft.AzureStackHCI/updates",
+ "location": "West US",
+ "properties": {
+ "installedDate": "2022-04-06T14:08:18.254Z",
+ "description": "AzS Update 4.2203.2.32",
+ "state": "Installed",
+ "prerequisites": [
+ {
+ "updateType": "update type",
+ "version": "prerequisite version",
+ "packageName": "update package name"
+ }
+ ],
+ "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32",
+ "packageSizeInMb": 18858,
+ "displayName": "AzS Update - 4.2203.2.32",
+ "version": "4.2203.2.32",
+ "publisher": "Microsoft",
+ "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203",
+ "availabilityType": "Local",
+ "packageType": "Infrastructure",
+ "updateStateProperties": {
+ "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify",
+ "progressPercentage": 0
+ },
+ "additionalProperties": "additional properties"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListArcSettingsByCluster.json
new file mode 100644
index 000000000000..9ee0ea698dcb
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListArcSettingsByCluster.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "arcInstanceResourceGroup": "ArcInstance-rg",
+ "aggregateState": "PartiallyConnected",
+ "perNodeDetails": [
+ {
+ "name": "Node-1",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
+ "state": "Connected"
+ },
+ {
+ "name": "Node-2",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2",
+ "state": "Disconnected"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersByResourceGroup.json
new file mode 100644
index 000000000000..28070c51c093
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersByResourceGroup.json
@@ -0,0 +1,123 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1",
+ "name": "myCluster1",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {},
+ "trialDaysRemaining": 29,
+ "billingModel": "Trial"
+ }
+ },
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2",
+ "name": "myCluster2",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {
+ "clusterName": "cluster1",
+ "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
+ "clusterVersion": "10.0.17777",
+ "nodes": [
+ {
+ "name": "Node1",
+ "id": 0,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q45CZC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node2",
+ "id": 1,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44BSC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node3",
+ "id": 2,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44RFC3",
+ "coreCount": 16,
+ "memoryInGiB": 256
+ }
+ ],
+ "lastUpdated": "2020-03-11T19:24:42.1946017Z",
+ "imdsAttestation": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersBySubscription.json
new file mode 100644
index 000000000000..9f854347adec
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListClustersBySubscription.json
@@ -0,0 +1,122 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1",
+ "name": "myCluster1",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "NotYetRegistered",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {},
+ "trialDaysRemaining": 29,
+ "billingModel": "Trial"
+ }
+ },
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2",
+ "name": "myCluster2",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "West US",
+ "tags": {},
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {
+ "clusterName": "cluster1",
+ "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
+ "clusterVersion": "10.0.17777",
+ "nodes": [
+ {
+ "name": "Node1",
+ "id": 0,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q45CZC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node2",
+ "id": 1,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44BSC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node3",
+ "id": 2,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44RFC3",
+ "coreCount": 16,
+ "memoryInGiB": 256
+ }
+ ],
+ "lastUpdated": "2020-03-11T19:24:42.1946017Z",
+ "imdsAttestation": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListExtensionsByArcSetting.json
new file mode 100644
index 000000000000..6fac8984eac5
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListExtensionsByArcSetting.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
+ "name": "MicrosoftMonitoringAgent",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "workspaceId": "xx"
+ }
+ },
+ "aggregateState": "PartiallyConnected",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
+ "state": "Connected"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
+ "state": "Disconnected"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension",
+ "name": "CustomScriptExtension",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.CustomScriptExtension",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "scriptLocation": "xx"
+ }
+ },
+ "aggregateState": "PartiallySucceeded",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension",
+ "state": "Succeeded"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension",
+ "state": "Failed"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByCluster.json
new file mode 100644
index 000000000000..cbeff9df2487
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByCluster.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers/offers",
+ "name": "offer1",
+ "properties": {
+ "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.
\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}",
+ "contentVersion": "2018-01-01",
+ "publisherId": "publisher1",
+ "provisioningState": "Succeeded",
+ "skuMappings": [
+ {
+ "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm",
+ "marketplaceSkuId": "enterprise",
+ "marketplaceSkuVersions": [
+ "15.0.220208"
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByPublisher.json
new file mode 100644
index 000000000000..536306d9408a
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOffersByPublisher.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "publisherName": "publisher1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers/offers",
+ "name": "offer1",
+ "properties": {
+ "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.
\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}",
+ "contentVersion": "2018-01-01",
+ "publisherId": "publisher1",
+ "provisioningState": "Succeeded",
+ "skuMappings": [
+ {
+ "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm",
+ "marketplaceSkuId": "enterprise",
+ "marketplaceSkuVersions": [
+ "15.0.220208"
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOperations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOperations.json
new file mode 100644
index 000000000000..28748333f866
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListOperations.json
@@ -0,0 +1,453 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.AzureStackHCI/Register/Action",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Register",
+ "operation": "Registers the Azure Stack HCI Resource Provider",
+ "description": "Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources."
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Unregister/Action",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Unregister",
+ "operation": "Unregisters the Azure Stack HCI Resource Provider",
+ "description": "Unregisters the subscription for the Azure Stack HCI resource provider."
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Operations/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Operations",
+ "operation": "Gets/List operations resources",
+ "description": "Gets operations"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters",
+ "operation": "Gets/List cluster resources",
+ "description": "Gets clusters"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters",
+ "operation": "Create/update cluster resources",
+ "description": "Creates or updates a cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters",
+ "operation": "Deletes cluster resource",
+ "description": "Deletes cluster resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings",
+ "operation": "Gets/List arc resources",
+ "description": "Gets arc resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings",
+ "operation": "Create/Update arc resources",
+ "description": "Create or updates arc resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings",
+ "operation": "Delete arc resources",
+ "description": "Delete arc resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings/Extensions",
+ "operation": "Gets/List extension resources of HCI cluster",
+ "description": "Gets extension resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings/Extensions",
+ "operation": "Create/Update extension resources of HCI cluster",
+ "description": "Create or update extension resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/ArcSettings/Extensions",
+ "operation": "Delete extension resources of HCI cluster",
+ "description": "Delete extension resources of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Restart/Action",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Restarts virtual machine resource",
+ "description": "Restarts virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Start/Action",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Starts virtual machine resource",
+ "description": "Starts virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Stop/Action",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Stops virtual machine resource",
+ "description": "Stops virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Deletes virtual machine resource",
+ "description": "Deletes virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Creates/Updates virtual machine resource",
+ "description": "Creates/Updates virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines",
+ "operation": "Gets/Lists virtual machine resource",
+ "description": "Gets/Lists virtual machine resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualNetworks/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualNetworks",
+ "operation": "Deletes virtual networks resource",
+ "description": "Deletes virtual networks resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualNetworks/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualNetworks",
+ "operation": "Creates/Updates virtual networks resource",
+ "description": "Creates/Updates virtual networks resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualNetworks/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualNetworks",
+ "operation": "Gets/Lists virtual networks resource",
+ "description": "Gets/Lists virtual networks resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualHardDisks",
+ "operation": "Deletes virtual hard disk resource",
+ "description": "Deletes virtual hard disk resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualHardDisks",
+ "operation": "Creates/Updates virtual hard disk resource",
+ "description": "Creates/Updates virtual hard disk resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualHardDisks",
+ "operation": "Gets/Lists virtual hard disk resource",
+ "description": "Gets/Lists virtual hard disk resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "NetworkInterfaces",
+ "operation": "Deletes network interfaces resource",
+ "description": "Deletes network interfaces resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "NetworkInterfaces",
+ "operation": "Creates/Updates network interfaces resource",
+ "description": "Creates/Updates network interfaces resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "NetworkInterfaces",
+ "operation": "Gets/Lists network interfaces resource",
+ "description": "Gets/Lists network interfaces resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/GalleryImages/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "GalleryImages",
+ "operation": "Deletes gallery images resource",
+ "description": "Deletes gallery images resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/GalleryImages/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "GalleryImages",
+ "operation": "Creates/Updates gallery images resource",
+ "description": "Creates/Updates gallery images resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/GalleryImages/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "GalleryImages",
+ "operation": "Gets/Lists gallery images resource",
+ "description": "Gets/Lists gallery images resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines/HybridIdentityMetadata",
+ "operation": "Gets/Lists virtual machine hybrid identity metadata proxy resource",
+ "description": "Gets/Lists virtual machine hybrid identity metadata proxy resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines/Extensions",
+ "operation": "Gets/Lists virtual machine extensions resource",
+ "description": "Gets/Lists virtual machine extensions resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines/Extensions",
+ "operation": "Creates/Updates virtual machine extensions resource",
+ "description": "Creates/Updates virtual machine extensions resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "VirtualMachines/Extensions",
+ "operation": "Deletes virtual machine extensions resource",
+ "description": "Deletes virtual machine extensions resource"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/RegisteredSubscriptions/read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "RegisteredSubscriptions",
+ "operation": "Gets/Lists registered subscriptions",
+ "description": "Reads registered subscriptions"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates",
+ "operation": "Gets/List available updates for HCI cluster",
+ "description": "Gets available updates for HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates",
+ "operation": "Create/Update updates resource of HCI cluster",
+ "description": "Create or update updates resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates",
+ "operation": "Delete updates resources of HCI cluster",
+ "description": "Delete updates resources of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/UpdateSummaries",
+ "operation": "Gets/List available update summaries for HCI cluster",
+ "description": "Gets available update summaries for HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/UpdateSummaries",
+ "operation": "Create/Update update summaries resource of HCI cluster",
+ "description": "Create or update update summaries resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/UpdateSummaries",
+ "operation": "Delete updates resource summaries of HCI cluster",
+ "description": "Delete update summaries resources of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates/UpdateRuns",
+ "operation": "Gets/List available update runs for HCI cluster",
+ "description": "Gets available update runs for HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates/UpdateRuns",
+ "operation": "Create/Update update runs resource of HCI cluster",
+ "description": "Create or update update runs resource of HCI cluster"
+ }
+ },
+ {
+ "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.AzureStackHCI",
+ "resource": "Clusters/Updates/UpdateRuns",
+ "operation": "Delete updates resource runs of HCI cluster",
+ "description": "Delete update runs resources of HCI cluster"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListPublishersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListPublishersByCluster.json
new file mode 100644
index 000000000000..74026e5e33b9
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListPublishersByCluster.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers",
+ "name": "publisher1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListSkusByOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListSkusByOffer.json
new file mode 100644
index 000000000000..84cb9acf9297
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListSkusByOffer.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "publisherName": "publisher1",
+ "offerName": "offer1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1",
+ "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus",
+ "name": "sku1",
+ "properties": {
+ "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.
\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}",
+ "contentVersion": "2018-01-01",
+ "publisherId": "publisher1",
+ "offerId": "offer1",
+ "skuMappings": [
+ {
+ "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm",
+ "marketplaceSkuId": "enterprise",
+ "marketplaceSkuVersions": [
+ "15.0.220208"
+ ]
+ }
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateRuns.json
new file mode 100644
index 000000000000..562e7c5aa6d7
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateRuns.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "type": "Microsoft.AzureStackHCI/updates/updateRuns",
+ "location": "West US",
+ "properties": {
+ "progress": {
+ "name": "Unnamed step",
+ "description": "Update Azure Stack.",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "steps": [
+ {
+ "name": "PreUpdate Cloud",
+ "description": "Prepare for SSU update",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "steps": []
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateSummaries.json
new file mode 100644
index 000000000000..9396ec8a0233
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdateSummaries.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default",
+ "name": "default",
+ "type": "Microsoft.AzureStackHCI/updateSummaries",
+ "location": "West US",
+ "properties": {
+ "oemFamily": "DellEMC",
+ "hardwareModel": "PowerEdge R730xd",
+ "packageVersions": [
+ {
+ "packageType": "OEM",
+ "version": "2.2.2108.6",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Services",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Infrastructure",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ }
+ ],
+ "currentVersion": "4.2203.2.32",
+ "state": "AppliedSuccessfully"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdates.json
new file mode 100644
index 000000000000..1fa807ce812e
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/ListUpdates.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32",
+ "name": "Microsoft4.2203.2.32",
+ "type": " Microsoft. AzureStackHCI/updates",
+ "location": "West US",
+ "properties": {
+ "installedDate": "2022-04-06T14:08:18.254Z",
+ "description": "AzS Update 4.2203.2.32",
+ "state": "Installed",
+ "prerequisites": [
+ {
+ "updateType": "update type",
+ "version": "prerequisite version",
+ "packageName": "update package name"
+ }
+ ],
+ "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32",
+ "packageSizeInMb": 18858,
+ "displayName": "AzS Update - 4.2203.2.32",
+ "version": "4.2203.2.32",
+ "publisher": "Microsoft",
+ "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203",
+ "availabilityType": "Local",
+ "packageType": "Infrastructure",
+ "updateStateProperties": {
+ "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify",
+ "progressPercentage": 0
+ },
+ "additionalProperties": "additional properties"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchArcSetting.json
new file mode 100644
index 000000000000..11667ac9cdf9
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchArcSetting.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "arcSetting": {
+ "properties": {
+ "connectivityProperties": {
+ "enabled": true
+ }
+ }
+ },
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "arcInstanceResourceGroup": "ArcInstance-rg",
+ "aggregateState": "Creating",
+ "connectivityProperties": {
+ "enabled": true
+ },
+ "perNodeDetails": [
+ {
+ "name": "Node-1",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
+ "state": "Creating"
+ },
+ {
+ "name": "Node-2",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2",
+ "state": "Creating"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchExtension.json
new file mode 100644
index 000000000000..56a3d2febe92
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PatchExtension.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "extensionName": "MicrosoftMonitoringAgent",
+ "extension": {
+ "properties": {
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "typeHandlerVersion": "1.10",
+ "type": "MicrosoftMonitoringAgent",
+ "settings": {
+ "workspaceId": "xx"
+ }
+ }
+ }
+ },
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
+ "name": "MicrosoftMonitoringAgent",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "workspaceId": "xx"
+ }
+ },
+ "aggregateState": "PartiallyConnected",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
+ "state": "Connected"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
+ "state": "Disconnected"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PostUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PostUpdates.json
new file mode 100644
index 000000000000..3031fe37fd22
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PostUpdates.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutArcSetting.json
new file mode 100644
index 000000000000..cc0fab862ed1
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutArcSetting.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "arcSetting": {},
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "arcInstanceResourceGroup": "ArcInstance-rg",
+ "aggregateState": "Creating",
+ "perNodeDetails": [
+ {
+ "name": "Node-1",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1",
+ "state": "Creating"
+ },
+ {
+ "name": "Node-2",
+ "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2",
+ "state": "Creating"
+ }
+ ],
+ "connectivityProperties": {
+ "enabled": false
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutExtension.json
new file mode 100644
index 000000000000..2fb616f668c5
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutExtension.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "arcSettingName": "default",
+ "extensionName": "MicrosoftMonitoringAgent",
+ "extension": {
+ "properties": {
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "typeHandlerVersion": "1.10",
+ "type": "MicrosoftMonitoringAgent",
+ "settings": {
+ "workspaceId": "xx"
+ },
+ "protectedSettings": {
+ "workspaceKey": "xx"
+ }
+ }
+ }
+ },
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
+ "name": "MicrosoftMonitoringAgent",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "workspaceId": "xx"
+ }
+ },
+ "aggregateState": "PartiallySucceeded",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
+ "state": "Succeeded"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
+ "state": "Failed"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent",
+ "name": "MicrosoftMonitoringAgent",
+ "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2021-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "extensionParameters": {
+ "publisher": "Microsoft.Compute",
+ "type": "string",
+ "typeHandlerVersion": "1.10.3",
+ "autoUpgradeMinorVersion": false,
+ "settings": {
+ "workspaceId": "xx"
+ }
+ },
+ "aggregateState": "PartiallySucceeded",
+ "perNodeExtensionDetails": [
+ {
+ "name": "Node-1",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent",
+ "state": "Succeeded"
+ },
+ {
+ "name": "Node-2",
+ "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent",
+ "state": "Failed"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateRuns.json
new file mode 100644
index 000000000000..c1d780b6287c
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateRuns.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "api-version": "2022-12-01",
+ "updateRunsProperties": {
+ "properties": {
+ "progress": {
+ "name": "Unnamed step",
+ "description": "Update Azure Stack.",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "steps": [
+ {
+ "name": "PreUpdate Cloud",
+ "description": "Prepare for SSU update",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "steps": []
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3",
+ "type": "Microsoft.AzureStackHCI/updates/updateRuns",
+ "location": "West US",
+ "properties": {
+ "progress": {
+ "name": "Unnamed step",
+ "description": "Update Azure Stack.",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00",
+ "steps": [
+ {
+ "name": "PreUpdate Cloud",
+ "description": "Prepare for SSU update",
+ "errorMessage": "",
+ "status": "Success",
+ "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00",
+ "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00",
+ "steps": []
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateSummaries.json
new file mode 100644
index 000000000000..e76d6aea674b
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdateSummaries.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01",
+ "updateLocationProperties": {
+ "properties": {
+ "oemFamily": "DellEMC",
+ "hardwareModel": "PowerEdge R730xd",
+ "lastChecked": "2022-04-07T18:04:07Z",
+ "currentVersion": "4.2203.2.32",
+ "lastUpdated": "2022-04-06T14:08:18.254Z",
+ "state": "AppliedSuccessfully"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default",
+ "name": "default",
+ "type": "Microsoft.AzureStackHCI/updateSummaries",
+ "location": "West US",
+ "properties": {
+ "oemFamily": "DellEMC",
+ "hardwareModel": "PowerEdge R730xd",
+ "packageVersions": [
+ {
+ "packageType": "OEM",
+ "version": "2.2.2108.6",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Services",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ },
+ {
+ "packageType": "Infrastructure",
+ "version": "4.2203.2.32",
+ "lastUpdated": "2022-04-07T18:04:07Z"
+ }
+ ],
+ "currentVersion": "4.2203.2.32",
+ "state": "AppliedSuccessfully"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdates.json
new file mode 100644
index 000000000000..f5556c168d02
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/PutUpdates.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712",
+ "resourceGroupName": "testrg",
+ "clusterName": "testcluster",
+ "updateName": "Microsoft4.2203.2.32",
+ "api-version": "2022-12-01",
+ "updateProperties": {
+ "properties": {
+ "installedDate": "2022-04-06T14:08:18.254Z",
+ "description": "AzS Update 4.2203.2.32",
+ "state": "Installed",
+ "prerequisites": [
+ {
+ "updateType": "update type",
+ "version": "prerequisite version",
+ "packageName": "update package name"
+ }
+ ],
+ "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32",
+ "packageSizeInMb": 18858,
+ "displayName": "AzS Update - 4.2203.2.32",
+ "version": "4.2203.2.32",
+ "publisher": "Microsoft",
+ "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203",
+ "availabilityType": "Local",
+ "packageType": "Infrastructure",
+ "updateStateProperties": {
+ "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify",
+ "progressPercentage": 0
+ },
+ "additionalProperties": "additional properties"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32",
+ "name": "Microsoft4.2203.2.32",
+ "type": "Microsoft.AzureStackHCI/updates",
+ "location": "West US",
+ "properties": {
+ "installedDate": "2022-04-06T14:08:18.254Z",
+ "description": "AzS Update 4.2203.2.32",
+ "state": "Installed",
+ "prerequisites": [
+ {
+ "updateType": "update type",
+ "version": "prerequisite version",
+ "packageName": "update package name"
+ }
+ ],
+ "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32",
+ "packageSizeInMb": 18858,
+ "displayName": "AzS Update - 4.2203.2.32",
+ "version": "4.2203.2.32",
+ "publisher": "Microsoft",
+ "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203",
+ "availabilityType": "Local",
+ "packageType": "Infrastructure",
+ "updateStateProperties": {
+ "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify",
+ "progressPercentage": 0
+ },
+ "additionalProperties": "additional properties"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UpdateCluster.json
new file mode 100644
index 000000000000..7ee6976ce70d
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UpdateCluster.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01",
+ "cluster": {
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster",
+ "name": "myCluster",
+ "type": "Microsoft.AzureStackHCI/clusters",
+ "location": "East US",
+ "identity": {
+ "principalId": "87a834db-2e45-409e-911b-e16a44562ec3",
+ "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "type": "SystemAssigned"
+ },
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": "ConnectedRecently",
+ "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd",
+ "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
+ "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be",
+ "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
+ "desiredProperties": {
+ "windowsServerSubscription": "Enabled",
+ "diagnosticLevel": "Basic"
+ },
+ "reportedProperties": {
+ "clusterName": "cluster1",
+ "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425",
+ "clusterVersion": "10.0.17777",
+ "nodes": [
+ {
+ "name": "Node1",
+ "id": 1,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q45CZC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node2",
+ "id": 2,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44BSC3",
+ "coreCount": 8,
+ "memoryInGiB": 128
+ },
+ {
+ "name": "Node3",
+ "id": 3,
+ "windowsServerSubscription": "Enabled",
+ "manufacturer": "Dell Inc.",
+ "model": "EMC AX740",
+ "osName": "Azure Stack HCI",
+ "osVersion": "10.0.17777.1061",
+ "serialNumber": "Q44RFC3",
+ "coreCount": 16,
+ "memoryInGiB": 256
+ }
+ ],
+ "lastUpdated": "2020-03-11T19:24:42.1946017Z",
+ "imdsAttestation": "Disabled",
+ "diagnosticLevel": "Basic"
+ },
+ "trialDaysRemaining": 30,
+ "billingModel": "Trial",
+ "registrationTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z",
+ "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UploadCertificate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UploadCertificate.json
new file mode 100644
index 000000000000..bdc3f4c1fdf2
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/examples/UploadCertificate.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b",
+ "resourceGroupName": "test-rg",
+ "clusterName": "myCluster",
+ "api-version": "2022-12-01",
+ "uploadCertificateRequest": {
+ "properties": {
+ "certificates": [
+ "base64cert",
+ "base64cert"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationStatuses"
+ }
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/extensions.json
new file mode 100644
index 000000000000..3b8d2d581c01
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/extensions.json
@@ -0,0 +1,520 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions": {
+ "get": {
+ "operationId": "Extensions_ListByArcSetting",
+ "description": "List all Extensions under ArcSetting resource.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExtensionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Extensions under ArcSetting resource": {
+ "$ref": "./examples/ListExtensionsByArcSetting.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}": {
+ "get": {
+ "operationId": "Extensions_Get",
+ "description": "Get particular Arc Extension of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExtensionNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ArcSettings Extension": {
+ "$ref": "./examples/GetExtension.json"
+ }
+ }
+ },
+ "put": {
+ "operationId": "Extensions_Create",
+ "description": "Create Extension for HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExtensionNameParameter"
+ },
+ {
+ "name": "extension",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ },
+ "description": "Details of the Machine Extension to be created."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Succeeded",
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Create Arc Extension": {
+ "$ref": "./examples/PutExtension.json"
+ }
+ }
+ },
+ "patch": {
+ "operationId": "Extensions_Update",
+ "description": "Update Extension for HCI cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExtensionNameParameter"
+ },
+ {
+ "name": "extension",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ },
+ "description": "Details of the Machine Extension to be created."
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Extension"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "original-uri"
+ },
+ "x-ms-examples": {
+ "Update Arc Extension": {
+ "$ref": "./examples/PatchExtension.json"
+ }
+ }
+ },
+ "delete": {
+ "operationId": "Extensions_Delete",
+ "description": "Delete particular Arc Extension of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ArcSettingNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExtensionNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Delete Arc Extension": {
+ "$ref": "./examples/DeleteExtension.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Extension": {
+ "description": "Details of a particular extension in HCI Cluster.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Describes Machine Extension Properties.",
+ "$ref": "#/definitions/ExtensionProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ExtensionProperties": {
+ "description": "Status of Arc Extension for a particular node in HCI Cluster.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the Extension proxy resource.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "extensionParameters": {
+ "description": "Parameters specific to this extension type.",
+ "$ref": "#/definitions/ExtensionParameters",
+ "x-ms-client-flatten": true
+ },
+ "aggregateState": {
+ "description": "Aggregate state of Arc Extensions across the nodes in this HCI cluster.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Canceled",
+ "Failed",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "ExtensionAggregateState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "perNodeExtensionDetails": {
+ "description": "State of Arc Extension in each of the nodes.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PerNodeExtensionState"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "PerNodeExtensionState": {
+ "description": "Status of Arc Extension for a particular node in HCI Cluster.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the node in HCI Cluster.",
+ "type": "string",
+ "readOnly": true
+ },
+ "extension": {
+ "description": "Fully qualified resource ID for the particular Arc Extension on this node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "state": {
+ "description": "State of Arc Extension in this node.",
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Error",
+ "Succeeded",
+ "Canceled",
+ "Failed",
+ "Connected",
+ "Disconnected",
+ "Deleted",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Moving",
+ "PartiallySucceeded",
+ "PartiallyConnected",
+ "InProgress",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "NodeExtensionState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ExtensionList": {
+ "description": "List of Extensions in HCI cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Extensions in HCI cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Extension"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ExtensionParameters": {
+ "description": "Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.",
+ "type": "object",
+ "properties": {
+ "forceUpdateTag": {
+ "type": "string",
+ "description": "How the extension handler should be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "settings": {
+ "type": "object",
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": "object",
+ "description": "Protected settings (may contain secrets).",
+ "x-ms-secret": true
+ },
+ "enableAutomaticUpgrade": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "ArcSettingNameParameter": {
+ "name": "arcSettingName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proxy resource holding details of HCI ArcSetting information.",
+ "x-ms-parameter-location": "method"
+ },
+ "ExtensionNameParameter": {
+ "name": "extensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the machine extension.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/offers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/offers.json
new file mode 100644
index 000000000000..2c21374fdf6c
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/offers.json
@@ -0,0 +1,302 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers": {
+ "get": {
+ "operationId": "Offers_ListByPublisher",
+ "description": "List Offers available for a publisher within the HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PublisherNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ODataExpandParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Offer resources by publisher for the HCI Cluster": {
+ "$ref": "./examples/ListOffersByPublisher.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers": {
+ "get": {
+ "operationId": "Offers_ListByCluster",
+ "description": "List Offers available across publishers for the HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ODataExpandParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Offer resources by HCI Cluster": {
+ "$ref": "./examples/ListOffersByCluster.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}": {
+ "get": {
+ "operationId": "Offers_Get",
+ "description": "Get Offer resource details within a publisher of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PublisherNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OfferNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ODataExpandParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Offer"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Offer": {
+ "$ref": "./examples/GetOffer.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "OfferList": {
+ "description": "List of Offer proxy resources for the HCI cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Offer proxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Offer"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Offer": {
+ "description": "Offer details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Offer properties.",
+ "$ref": "#/definitions/OfferProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OfferProperties": {
+ "description": "Publisher properties.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning State",
+ "type": "string",
+ "readOnly": true
+ },
+ "publisherId": {
+ "type": "string",
+ "description": "Identifier of the Publisher for the offer"
+ },
+ "content": {
+ "type": "string",
+ "description": "JSON serialized catalog content of the offer"
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "The API version of the catalog service used to serve the catalog content"
+ },
+ "skuMappings": {
+ "type": "array",
+ "description": "Array of SKU mappings",
+ "items": {
+ "$ref": "#/definitions/SkuMappings"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "SkuMappings": {
+ "description": "SKU Mapping details.",
+ "type": "object",
+ "properties": {
+ "catalogPlanId": {
+ "type": "string",
+ "description": "Identifier of the CatalogPlan for the sku"
+ },
+ "marketplaceSkuId": {
+ "type": "string",
+ "description": "Identifier for the sku"
+ },
+ "marketplaceSkuVersions": {
+ "type": "array",
+ "description": "Array of SKU versions available",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "PublisherNameParameter": {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the publisher available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "OfferNameParameter": {
+ "name": "offerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the offer available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "ODataExpandParameter": {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/operations.json
new file mode 100644
index 000000000000..2b4da98b286b
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/operations.json
@@ -0,0 +1,73 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.AzureStackHCI/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "Create cluster": {
+ "$ref": "./examples/ListOperations.json"
+ }
+ },
+ "description": "List all available Microsoft.AzureStackHCI provider operations",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {},
+ "parameters": {}
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/publishers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/publishers.json
new file mode 100644
index 000000000000..8eb3a961c110
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/publishers.json
@@ -0,0 +1,188 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers": {
+ "get": {
+ "operationId": "Publishers_ListByCluster",
+ "description": "List Publishers available for the HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublisherList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Publisher resources by HCI Cluster": {
+ "$ref": "./examples/ListPublishersByCluster.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}": {
+ "get": {
+ "operationId": "Publishers_Get",
+ "description": "Get Publisher resource details of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PublisherNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Publisher"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Publisher": {
+ "$ref": "./examples/GetPublisher.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "PublisherList": {
+ "description": "List of Publisher proxy resources for the HCI cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Publisher proxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Publisher"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Publisher": {
+ "description": "Publisher details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Publisher properties.",
+ "$ref": "#/definitions/PublisherProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PublisherProperties": {
+ "description": "Publisher properties.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning State",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "PublisherNameParameter": {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the publisher available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/skus.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/skus.json
new file mode 100644
index 000000000000..c3473fc733f8
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/skus.json
@@ -0,0 +1,275 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus": {
+ "get": {
+ "operationId": "Skus_ListByOffer",
+ "description": "List Skus available for a offer within the HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PublisherNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OfferNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ODataExpandParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SkuList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List SKU resources by offer for the HCI Cluster": {
+ "$ref": "./examples/ListSkusByOffer.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}": {
+ "get": {
+ "operationId": "Skus_Get",
+ "description": "Get SKU resource details within a offer of HCI Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PublisherNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OfferNameParameter"
+ },
+ {
+ "$ref": "#/parameters/SkuNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ODataExpandParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Sku"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Sku": {
+ "$ref": "./examples/GetSku.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "SkuList": {
+ "description": "List of SKU proxy resources for the HCI cluster.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of SKU proxy resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Sku"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Sku": {
+ "description": "Sku details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SKU properties.",
+ "$ref": "#/definitions/SkuProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SkuProperties": {
+ "description": "SKU properties.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning State",
+ "type": "string",
+ "readOnly": true
+ },
+ "publisherId": {
+ "type": "string",
+ "description": "Identifier of the Publisher for the offer"
+ },
+ "offerId": {
+ "type": "string",
+ "description": "Identifier of the Offer for the sku"
+ },
+ "content": {
+ "type": "string",
+ "description": "JSON serialized catalog content of the sku offer"
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "The API version of the catalog service used to serve the catalog content"
+ },
+ "skuMappings": {
+ "type": "array",
+ "description": "Array of SKU mappings",
+ "items": {
+ "$ref": "#/definitions/SkuMappings"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "SkuMappings": {
+ "description": "SKU Mapping details.",
+ "type": "object",
+ "properties": {
+ "catalogPlanId": {
+ "type": "string",
+ "description": "Identifier of the CatalogPlan for the sku"
+ },
+ "marketplaceSkuId": {
+ "type": "string",
+ "description": "Identifier for the sku"
+ },
+ "marketplaceSkuVersions": {
+ "type": "array",
+ "description": "Array of SKU versions available",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "PublisherNameParameter": {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the publisher available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "OfferNameParameter": {
+ "name": "offerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the offer available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "SkuNameParameter": {
+ "name": "skuName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SKU available within HCI cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "ODataExpandParameter": {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateRuns.json
new file mode 100644
index 000000000000..efbdc3844c86
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateRuns.json
@@ -0,0 +1,408 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns": {
+ "get": {
+ "operationId": "UpdateRuns_List",
+ "description": "List all Update runs for a specified update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateRunList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Update runs under cluster resource": {
+ "$ref": "./examples/ListUpdateRuns.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}": {
+ "delete": {
+ "operationId": "UpdateRuns_Delete",
+ "description": "Delete specified Update Run",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateRunNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "ACCEPTED",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Delete an Update": {
+ "$ref": "./examples/DeleteUpdateRuns.json"
+ }
+ }
+ },
+ "put": {
+ "operationId": "UpdateRuns_Put",
+ "description": "Put Update runs for a specified update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateRunNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "updateRunsProperties",
+ "in": "body",
+ "description": "Properties of the updateRuns object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UpdateRun"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateRun"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Update runs under cluster resource": {
+ "$ref": "./examples/PutUpdateRuns.json"
+ }
+ }
+ },
+ "get": {
+ "operationId": "UpdateRuns_Get",
+ "description": "Get the Update run for a specified update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateRunNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateRun"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Update runs under cluster resource": {
+ "$ref": "./examples/GetUpdateRuns.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "UpdateRunList": {
+ "description": "List of Update runs",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Update runs",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdateRun"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateRun": {
+ "description": "Details of an Update run",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ },
+ "properties": {
+ "description": "Describes Update Run Properties.",
+ "$ref": "#/definitions/UpdateRunProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateRunProperties": {
+ "description": "Details of an Update run",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the UpdateRuns proxy resource.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "timeStarted": {
+ "description": "Timestamp of the update run was started.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastUpdatedTime": {
+ "description": "Timestamp of the most recently completed step in the update run.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "duration": {
+ "description": "Duration of the update run.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the update run.",
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "Succeeded",
+ "InProgress",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "updateRunPropertiesState",
+ "modelAsString": true
+ }
+ },
+ "progress": {
+ "description": "Progress representation of the update run steps.",
+ "$ref": "#/definitions/Step",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Step": {
+ "description": "Progress representation of the update run steps.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the step.",
+ "type": "string"
+ },
+ "description": {
+ "description": "More detailed description of the step.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Error message, specified if the step is in a failed state.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.",
+ "type": "string"
+ },
+ "startTimeUtc": {
+ "description": "When the step started, or empty if it has not started executing.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endTimeUtc": {
+ "description": "When the step reached a terminal state.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastUpdatedTimeUtc": {
+ "description": "Completion time of this step or the last completed sub-step.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "steps": {
+ "description": "Recursive model for child steps of this step.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Step"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "UpdateNameParameter": {
+ "name": "updateName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Update",
+ "x-ms-parameter-location": "method"
+ },
+ "UpdateRunNameParameter": {
+ "name": "updateRunName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Update Run",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateSummaries.json
new file mode 100644
index 000000000000..f8910c04e589
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updateSummaries.json
@@ -0,0 +1,482 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries": {
+ "get": {
+ "operationId": "UpdateSummaries_List",
+ "description": "List all Update summaries under the HCI cluster",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateSummariesList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Update summaries under cluster resource": {
+ "$ref": "./examples/ListUpdateSummaries.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default": {
+ "delete": {
+ "operationId": "UpdateSummaries_Delete",
+ "description": "Delete Update Summaries",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "ACCEPTED",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Delete an Update": {
+ "$ref": "./examples/DeleteUpdateSummaries.json"
+ }
+ }
+ },
+ "put": {
+ "operationId": "UpdateSummaries_Put",
+ "description": "Put Update summaries under the HCI cluster",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "updateLocationProperties",
+ "in": "body",
+ "description": "Properties of the UpdateSummaries resource",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UpdateSummaries"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateSummaries"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Put Update summaries under cluster resource": {
+ "$ref": "./examples/PutUpdateSummaries.json"
+ }
+ }
+ },
+ "get": {
+ "operationId": "UpdateSummaries_Get",
+ "description": "Get all Update summaries under the HCI cluster",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateSummaries"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Update summaries under cluster resource": {
+ "$ref": "./examples/GetUpdateSummaries.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "UpdateSummariesList": {
+ "description": "List of Update Summaries",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Update Summaries",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdateSummaries"
+ },
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateSummaries": {
+ "description": "Get the update summaries for the cluster",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ },
+ "properties": {
+ "description": "Update summaries properties",
+ "type": "object",
+ "$ref": "#/definitions/UpdateSummariesProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateSummariesProperties": {
+ "description": "Properties of Update summaries",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the UpdateSummaries proxy resource.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "oemFamily": {
+ "description": "OEM family name.",
+ "type": "string"
+ },
+ "hardwareModel": {
+ "description": "Name of the hardware model.",
+ "type": "string"
+ },
+ "packageVersions": {
+ "description": "Current version of each updatable component.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PackageVersionInfo"
+ },
+ "x-ms-client-flatten": true,
+ "x-ms-identifiers": [
+ "version"
+ ]
+ },
+ "currentVersion": {
+ "description": "Current Solution Bundle version of the stamp.",
+ "type": "string"
+ },
+ "lastUpdated": {
+ "description": "Last time an update installation completed successfully.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "lastChecked": {
+ "description": "Last time the update service successfully checked for updates",
+ "type": "string",
+ "format": "date-time"
+ },
+ "healthState": {
+ "description": "Overall health state for update-specific health checks.",
+ "type": "object",
+ "$ref": "#/definitions/HealthState",
+ "x-ms-client-flatten": true
+ },
+ "healthCheckResult": {
+ "description": "An array of pre-check result objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrecheckResult"
+ },
+ "x-ms-client-flatten": true,
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "healthCheckDate": {
+ "description": "Last time the package-specific checks were run.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "state": {
+ "description": "Overall update state of the stamp.",
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "AppliedSuccessfully",
+ "UpdateAvailable",
+ "UpdateInProgress",
+ "UpdateFailed",
+ "NeedsAttention",
+ "PreparationInProgress",
+ "PreparationFailed"
+ ],
+ "x-ms-enum": {
+ "name": "updateSummariesPropertiesState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PackageVersionInfo": {
+ "description": "Current version of each updatable component.",
+ "type": "object",
+ "properties": {
+ "packageType": {
+ "description": "Package type",
+ "type": "string"
+ },
+ "version": {
+ "description": "Package version",
+ "type": "string"
+ },
+ "lastUpdated": {
+ "description": "Last time this component was updated.",
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "HealthState": {
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "Success",
+ "Failure",
+ "Warning",
+ "Error",
+ "InProgress"
+ ],
+ "x-ms-enum": {
+ "name": "HealthState",
+ "modelAsString": true
+ }
+ },
+ "PrecheckResult": {
+ "properties": {
+ "name": {
+ "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Key-value pairs that allow grouping/filtering individual tests.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "Key that allow grouping/filtering individual tests.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the key that allow grouping/filtering individual tests.",
+ "type": "string"
+ }
+ }
+ },
+ "title": {
+ "description": "User-facing name; one or more sentences indicating the direct issue.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "InProgress"
+ ],
+ "x-ms-enum": {
+ "name": "status",
+ "modelAsString": true
+ }
+ },
+ "severity": {
+ "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.",
+ "type": "string",
+ "enum": [
+ "Critical",
+ "Warning",
+ "Informational",
+ "Hidden"
+ ],
+ "x-ms-enum": {
+ "name": "severity",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "description": "Detailed overview of the issue and what impact the issue has on the stamp.",
+ "type": "string"
+ },
+ "remediation": {
+ "description": "Set of steps that can be taken to resolve the issue found.",
+ "type": "string"
+ },
+ "targetResourceID": {
+ "description": "The unique identifier for the affected resource (such as a node or drive).",
+ "type": "string"
+ },
+ "targetResourceName": {
+ "description": "The name of the affected resource.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The Time in which the HealthCheck was called.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "additionalData": {
+ "description": "Property bag of key value pairs for additional information.",
+ "type": "string"
+ },
+ "healthCheckSource": {
+ "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updates.json
new file mode 100644
index 000000000000..5476f08107f5
--- /dev/null
+++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2022-12-01/updates.json
@@ -0,0 +1,654 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "AzureStackHCI",
+ "description": "Azure Stack HCI management service"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply": {
+ "post": {
+ "operationId": "Updates_Post",
+ "description": "Apply Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "ACCEPTED",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List available updates": {
+ "$ref": "./examples/PostUpdates.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates": {
+ "get": {
+ "operationId": "Updates_List",
+ "description": "List all Updates",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UpdateList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List available updates": {
+ "$ref": "./examples/ListUpdates.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}": {
+ "delete": {
+ "operationId": "Updates_Delete",
+ "description": "Delete specified Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "ACCEPTED",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Delete an Update": {
+ "$ref": "./examples/DeleteUpdates.json"
+ }
+ }
+ },
+ "put": {
+ "operationId": "Updates_Put",
+ "description": "Put specified Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "updateProperties",
+ "in": "body",
+ "description": "Properties of the Updates object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Update"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Update"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Put a specific update": {
+ "$ref": "./examples/PutUpdates.json"
+ }
+ }
+ },
+ "get": {
+ "operationId": "Updates_Get",
+ "description": "Get specified Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ClusterNameParameter"
+ },
+ {
+ "$ref": "#/parameters/UpdateNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Update"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a specific update": {
+ "$ref": "./examples/GetUpdates.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "UpdateList": {
+ "description": "List of Updates",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Updates",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Update"
+ }
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdatePrerequisite": {
+ "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.",
+ "type": "object",
+ "properties": {
+ "updateType": {
+ "description": "Updatable component type.",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the prerequisite.",
+ "type": "string"
+ },
+ "packageName": {
+ "description": "Friendly name of the prerequisite.",
+ "type": "string"
+ }
+ }
+ },
+ "Update": {
+ "description": "Update details",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ },
+ "properties": {
+ "description": "Update properties",
+ "type": "object",
+ "$ref": "#/definitions/UpdateProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateProperties": {
+ "description": "Details of a singular Update in HCI Cluster",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the Updates proxy resource.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Provisioning"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "installedDate": {
+ "description": "Date that the update was installed.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "description": {
+ "description": "Description of the update.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the update as it relates to this stamp.",
+ "type": "string",
+ "enum": [
+ "HasPrerequisite",
+ "Obsolete",
+ "Ready",
+ "NotApplicableBecauseAnotherUpdateIsInProgress",
+ "Preparing",
+ "Installing",
+ "Installed",
+ "PreparationFailed",
+ "InstallationFailed",
+ "Invalid",
+ "Recalled",
+ "Downloading",
+ "DownloadFailed",
+ "HealthChecking",
+ "HealthCheckFailed",
+ "ReadyToInstall",
+ "ScanInProgress",
+ "ScanFailed"
+ ],
+ "x-ms-enum": {
+ "name": "state",
+ "modelAsString": true
+ }
+ },
+ "prerequisites": {
+ "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdatePrerequisite"
+ },
+ "x-ms-identifiers": [
+ "packageName"
+ ]
+ },
+ "componentVersions": {
+ "description": "An array of component versions for a Solution Bundle update, and an empty array otherwise. ",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PackageVersionInfo"
+ },
+ "x-ms-client-flatten": true,
+ "x-ms-identifiers": [
+ "version"
+ ]
+ },
+ "rebootRequired": {
+ "type": "object",
+ "$ref": "#/definitions/RebootRequirement",
+ "x-ms-client-flatten": true
+ },
+ "healthState": {
+ "description": "Overall health state for update-specific health checks.",
+ "type": "object",
+ "$ref": "#/definitions/HealthState",
+ "x-ms-client-flatten": true
+ },
+ "healthCheckResult": {
+ "description": "An array of PrecheckResult objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrecheckResult"
+ },
+ "x-ms-client-flatten": true
+ },
+ "healthCheckDate": {
+ "description": "Last time the package-specific checks were run.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "packagePath": {
+ "description": "Path where the update package is available.",
+ "type": "string"
+ },
+ "packageSizeInMb": {
+ "description": "Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.",
+ "type": "number"
+ },
+ "displayName": {
+ "description": "Display name of the Update",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the update.",
+ "type": "string"
+ },
+ "publisher": {
+ "description": "Publisher of the update package.",
+ "type": "string"
+ },
+ "releaseLink": {
+ "description": "Link to release notes for the update.",
+ "type": "string"
+ },
+ "availabilityType": {
+ "description": "Indicates the way the update content can be downloaded.",
+ "type": "string",
+ "enum": [
+ "Local",
+ "Online",
+ "Notify"
+ ],
+ "x-ms-enum": {
+ "name": "availabilityType",
+ "modelAsString": true
+ }
+ },
+ "packageType": {
+ "description": "Customer-visible type of the update.",
+ "type": "string"
+ },
+ "additionalProperties": {
+ "description": "Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.",
+ "type": "string"
+ },
+ "updateStateProperties": {
+ "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.",
+ "type": "object",
+ "$ref": "#/definitions/UpdateStateProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateStateProperties": {
+ "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.",
+ "type": "object",
+ "properties": {
+ "progressPercentage": {
+ "description": "Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.",
+ "type": "number"
+ },
+ "notifyMessage": {
+ "description": "Brief message with instructions for updates of AvailabilityType Notify.",
+ "type": "string"
+ }
+ }
+ },
+ "PackageVersionInfo": {
+ "description": "Current version of each updatable component.",
+ "type": "object",
+ "properties": {
+ "packageType": {
+ "description": "Package type",
+ "type": "string"
+ },
+ "version": {
+ "description": "Package version",
+ "type": "string"
+ },
+ "lastUpdated": {
+ "description": "Last time this component was updated.",
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "RebootRequirement": {
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "True",
+ "False"
+ ],
+ "x-ms-enum": {
+ "name": "RebootRequirement",
+ "modelAsString": true
+ }
+ },
+ "HealthState": {
+ "type": "string",
+ "enum": [
+ "Unknown",
+ "Success",
+ "Failure",
+ "Warning",
+ "Error",
+ "InProgress"
+ ],
+ "x-ms-enum": {
+ "name": "HealthState",
+ "modelAsString": true
+ }
+ },
+ "PrecheckResult": {
+ "properties": {
+ "name": {
+ "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Key-value pairs that allow grouping/filtering individual tests.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "Key that allow grouping/filtering individual tests.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the key that allow grouping/filtering individual tests.",
+ "type": "string"
+ }
+ }
+ },
+ "title": {
+ "description": "User-facing name; one or more sentences indicating the direct issue.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "InProgress"
+ ],
+ "x-ms-enum": {
+ "name": "status",
+ "modelAsString": true
+ }
+ },
+ "severity": {
+ "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.",
+ "type": "string",
+ "enum": [
+ "Critical",
+ "Warning",
+ "Informational",
+ "Hidden"
+ ],
+ "x-ms-enum": {
+ "name": "severity",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "description": "Detailed overview of the issue and what impact the issue has on the stamp.",
+ "type": "string"
+ },
+ "remediation": {
+ "description": "Set of steps that can be taken to resolve the issue found.",
+ "type": "string"
+ },
+ "targetResourceID": {
+ "description": "The unique identifier for the affected resource (such as a node or drive).",
+ "type": "string"
+ },
+ "targetResourceName": {
+ "description": "The name of the affected resource.",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The Time in which the HealthCheck was called.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "additionalData": {
+ "description": "Property bag of key value pairs for additional information.",
+ "type": "string"
+ },
+ "healthCheckSource": {
+ "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ClusterNameParameter": {
+ "name": "clusterName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the cluster.",
+ "x-ms-parameter-location": "method"
+ },
+ "UpdateNameParameter": {
+ "name": "updateName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Update",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md
index 6312432f0dda..c8c2d903042d 100644
--- a/specification/azurestackhci/resource-manager/readme.md
+++ b/specification/azurestackhci/resource-manager/readme.md
@@ -29,7 +29,7 @@ title: AzureStackHCIClient
description: Azure Stack HCI management service
openapi-type: arm
openapi-subtype: rpaas
-tag: package-2022-10
+tag: package-2022-12
```
## Suppression
@@ -41,23 +41,43 @@ directive:
- arcSettings.json
- clusters.json
- extensions.json
+ - galleryImages.json
+ - networkInterfaces.json
- operations.json
+ - storageContainers.json
+ - virtualHardDisks.json
+ - virtualMachines.json
+ - virtualNetworks.json
- offers.json
- publishers.json
- skus.json
+ - updates.json
- updateRuns.json
- updateSummaries.json
- - updates.json
- - galleryImages.json
- - networkInterfaces.json
- - virtualHardDisks.json
- - virtualMachines.json
- - virtualNetworks.json
reason: Microsoft.AzureStackHCI is the correct name for our RP.
```
-### Tag: package-2022-10
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.AzureStackHCI/stable/2022-12-01/arcSettings.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/clusters.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/extensions.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/offers.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/operations.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/publishers.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/skus.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/updateRuns.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/updateSummaries.json
+ - Microsoft.AzureStackHCI/stable/2022-12-01/updates.json
+```
+
+
+### Tag: package-preview-2022-10
These settings apply only when `--tag=package-2022-10` is specified on the command line.
@@ -110,20 +130,6 @@ input-file:
- Microsoft.AzureStackHCI/stable/2022-03-01/extensions.json
- Microsoft.AzureStackHCI/stable/2022-03-01/operations.json
```
-
-### Tag: package-preview-2021-07
-
-These settings apply only when `--tag=package-preview-2021-07` is specified on the command line.
-
-``` yaml $(tag) == 'package-preview-2021-07'
-input-file:
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/galleryImages.json
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/networkInterfaces.json
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualHardDisks.json
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualNetworks.json
- - Microsoft.AzureStackHCI/preview/2021-07-01-preview/operations.json
-```
### Tag: package-2022-01
These settings apply only when `--tag=package-2022-01` is specified on the command line.
@@ -167,6 +173,20 @@ input-file:
- Microsoft.AzureStackHCI/stable/2021-09-01/operations.json
```
+### Tag: package-preview-2021-07
+
+These settings apply only when `--tag=package-preview-2021-07` is specified on the command line.
+
+``` yaml $(tag) == 'package-preview-2021-07'
+input-file:
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/galleryImages.json
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/networkInterfaces.json
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualHardDisks.json
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualMachines.json
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/virtualNetworks.json
+ - Microsoft.AzureStackHCI/preview/2021-07-01-preview/operations.json
+```
+
### Tag: package-preview-2021-01
These settings apply only when `--tag=package-preview-2021-01` is specified on the command line.
@@ -179,11 +199,11 @@ input-file:
- Microsoft.AzureStackHCI/preview/2021-01-01-preview/operations.json
```
-### Tag: package-2020-10
+### Tag: package-2020-10-01
-These settings apply only when `--tag=package-2020-10` is specified on the command line.
+These settings apply only when `--tag=package-2020-10-01` is specified on the command line.
-``` yaml $(tag) == 'package-2020-10'
+``` yaml $(tag) == 'package-2020-10-01'
input-file:
- Microsoft.AzureStackHCI/stable/2020-10-01/azurestackhci.json
```
@@ -208,7 +228,6 @@ This is not used by Autorest itself.
``` yaml $(swagger-to-sdk)
swagger-to-sdk:
- - repo: azure-sdk-for-net-track2
- repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-java
- repo: azure-sdk-for-go
@@ -217,6 +236,8 @@ swagger-to-sdk:
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_azurestackhci']
- repo: azure-resource-manager-schemas
+ after_scripts:
+ - node sdkauto_afterscript.js azurestackhci/resource-manager
- repo: azure-powershell
```
@@ -243,3 +264,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md)
## CSharp
See configuration in [readme.csharp.md](./readme.csharp.md)
+
+## AzureResourceSchema
+
+See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
diff --git a/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/billingbenefits.json b/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/billingbenefits.json
index dfb00b5cfc47..002803116365 100644
--- a/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/billingbenefits.json
+++ b/specification/billingbenefits/resource-manager/Microsoft.BillingBenefits/stable/2022-11-01/billingbenefits.json
@@ -1134,13 +1134,14 @@
"utilization": {
"$ref": "#/definitions/Utilization"
},
+ "renewSource": {
+ "$ref": "#/definitions/RenewSource"
+ },
+ "renewDestination": {
+ "$ref": "#/definitions/RenewDestination"
+ },
"renewProperties": {
- "type": "object",
- "properties": {
- "purchaseProperties": {
- "$ref": "#/definitions/PurchaseRequest"
- }
- }
+ "$ref": "#/definitions/RenewProperties"
}
}
},
diff --git a/specification/billingbenefits/resource-manager/readme.typescript.md b/specification/billingbenefits/resource-manager/readme.typescript.md
index a85050b4bed8..bef6f8d3f03e 100644
--- a/specification/billingbenefits/resource-manager/readme.typescript.md
+++ b/specification/billingbenefits/resource-manager/readme.typescript.md
@@ -11,4 +11,10 @@ typescript:
payload-flattening-threshold: 1
clear-output-folder: true
generate-metadata: true
+
+directive:
+- from: swagger-document
+ where: $.parameters.ExpandParameter
+ transform: >
+ $["x-ms-parameter-location"] = "method";
```
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json
index 1a04dadac557..62cbd6deda6d 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json
@@ -309,16 +309,19 @@
"description": "Creates a Channel registration for a Bot Service",
"operationId": "Channels_Create",
"x-ms-examples": {
- "Create Bot": {
+ "Create Channel": {
"$ref": "./examples/PutChannel.json"
},
- "Create Alexa Bot": {
+ "Create Alexa Channel": {
"$ref": "./examples/PutAlexaChannel.json"
},
- "Create Line Bot": {
+ "Create Email Channel": {
+ "$ref": "./examples/PutEmailChannel.json"
+ },
+ "Create Line Channel": {
"$ref": "./examples/PutLineChannel.json"
},
- "Create DirectLine Speech Bot": {
+ "Create DirectLine Speech Channel": {
"$ref": "./examples/PutDirectLineSpeechChannel.json"
}
},
@@ -376,16 +379,16 @@
"description": "Updates a Channel registration for a Bot Service",
"operationId": "Channels_Update",
"x-ms-examples": {
- "Update Bot": {
+ "Update Channel": {
"$ref": "./examples/UpdateChannel.json"
},
- "Update Alexa": {
+ "Update Alexa Channel": {
"$ref": "./examples/UpdateAlexaChannel.json"
},
- "Update Line": {
+ "Update Line Channel": {
"$ref": "./examples/UpdateLineChannel.json"
},
- "Update DirectLine Speech": {
+ "Update DirectLine Speech Channel": {
"$ref": "./examples/UpdateDirectLineSpeechChannel.json"
}
},
@@ -444,10 +447,10 @@
"description": "Deletes a Channel registration from a Bot Service",
"operationId": "Channels_Delete",
"x-ms-examples": {
- "Delete Bot": {
+ "Delete Channel": {
"$ref": "./examples/DeleteChannel.json"
},
- "Delete DirectLine Speech Bot": {
+ "Delete DirectLine Speech Channel": {
"$ref": "./examples/DeleteDirectLineSpeechChannel.json"
}
},
@@ -497,16 +500,16 @@
"description": "Returns a BotService Channel registration specified by the parameters.",
"operationId": "Channels_Get",
"x-ms-examples": {
- "Get Bot": {
+ "Get Channel": {
"$ref": "./examples/GetChannel.json"
},
- "Get Alexa Bot": {
+ "Get Alexa Channel": {
"$ref": "./examples/GetAlexaChannel.json"
},
- "Get Line Bot": {
+ "Get Line Channel": {
"$ref": "./examples/GetLineChannel.json"
},
- "Get DirectLine Speech Bot": {
+ "Get DirectLine Speech Channel": {
"$ref": "./examples/GetDirectLineSpeechChannel.json"
}
},
@@ -603,7 +606,7 @@
"description": "Returns all the Channel registrations of a particular BotService resource",
"operationId": "Channels_ListByResourceGroup",
"x-ms-examples": {
- "List Bots by Resource Group": {
+ "List Channels by Resource Group": {
"$ref": "./examples/ListChannelsByBotService.json"
}
},
@@ -818,7 +821,7 @@
"BotConnection"
],
"x-ms-examples": {
- "Update Connection Setting": {
+ "List Connection Setting With Secrets": {
"$ref": "./examples/GetConnection.json"
}
},
@@ -979,7 +982,7 @@
"BotConnection"
],
"x-ms-examples": {
- "Update Connection Setting": {
+ "Get Connection Setting": {
"$ref": "./examples/GetConnection.json"
}
},
@@ -1024,7 +1027,7 @@
"description": "Deletes a Connection Setting registration for a Bot Service",
"operationId": "BotConnection_Delete",
"x-ms-examples": {
- "Update Connection Setting": {
+ "Delete Connection Setting": {
"$ref": "./examples/DeleteConnection.json"
}
},
@@ -1462,14 +1465,6 @@
"etag": {
"type": "string",
"description": "Entity Tag"
- },
- "zones": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Entity zones",
- "readOnly": true
}
}
},
@@ -1523,7 +1518,11 @@
"x-ms-enum": {
"name": "Kind",
"modelAsString": true
- }
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"Bot": {
"type": "object",
@@ -1552,11 +1551,13 @@
},
"iconUrl": {
"type": "string",
- "description": "The Icon Url of the bot"
+ "description": "The Icon Url of the bot",
+ "default": ""
},
"endpoint": {
"type": "string",
- "description": "The bot's endpoint"
+ "description": "The bot's endpoint",
+ "x-nullable": true
},
"endpointVersion": {
"type": "string",
@@ -1596,11 +1597,19 @@
},
"msaAppId": {
"type": "string",
- "description": "Microsoft App Id for the bot"
+ "description": "Microsoft App Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"msaAppTenantId": {
"type": "string",
- "description": "Microsoft App Tenant Id for the bot"
+ "description": "Microsoft App Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"msaAppMSIResourceId": {
"type": "string",
@@ -1647,7 +1656,8 @@
},
"isCmekEnabled": {
"type": "boolean",
- "description": "Whether Cmek is enabled"
+ "description": "Whether Cmek is enabled",
+ "default": false
},
"cmekKeyVaultUrl": {
"type": "string",
@@ -1658,6 +1668,14 @@
"description": "The CMK encryption status",
"readOnly": true
},
+ "tenantId": {
+ "type": "string",
+ "description": "The Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
"publicNetworkAccess": {
"description": "Whether the bot is in an isolated network",
"enum": [
@@ -1688,11 +1706,14 @@
},
"disableLocalAuth": {
"type": "boolean",
- "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.",
+ "x-nullable": true
},
"schemaTransformationVersion": {
"type": "string",
- "description": "The channel schema transformation version for the bot"
+ "description": "The channel schema transformation version for the bot",
+ "x-nullable": true,
+ "default": null
},
"storageResourceId": {
"type": "string",
@@ -1800,11 +1821,13 @@
"properties": {
"extensionKey1": {
"type": "string",
- "description": "The extensionKey1"
+ "description": "The extensionKey1",
+ "default": ""
},
"extensionKey2": {
"type": "string",
- "description": "The extensionKey2"
+ "description": "The extensionKey2",
+ "default": ""
},
"sites": {
"type": "array",
@@ -1827,7 +1850,8 @@
},
"botIconUrl": {
"type": "string",
- "description": "The bot icon url"
+ "description": "The bot icon url",
+ "x-nullable": true
},
"isEnabled": {
"type": "boolean",
@@ -1836,6 +1860,11 @@
"disableLocalAuth": {
"type": "boolean",
"description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "requireTermsAgreement": {
+ "type": "boolean",
+ "description": "Whether customer needs to agree to new terms.",
+ "x-ms-nullable": true
}
}
},
@@ -1851,7 +1880,11 @@
"etag": {
"type": "string",
"description": "Entity Tag of the resource",
- "x-nullable": true
+ "x-nullable": true,
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"provisioningState": {
"type": "string",
@@ -2006,10 +2039,18 @@
"type": "string",
"description": "The email address"
},
+ "authMethod": {
+ "$ref": "#/definitions/EmailChannelAuthMethod",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph."
+ },
"password": {
"type": "string",
"description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty."
},
+ "magicCode": {
+ "type": "string",
+ "description": "The magic code for setting up the modern authentication."
+ },
"isEnabled": {
"type": "boolean",
"description": "Whether this channel is enabled for the bot"
@@ -2021,6 +2062,40 @@
"isEnabled"
]
},
+ "EmailChannelAuthMethod": {
+ "type": "number",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph.",
+ "enum": [
+ 0,
+ 1
+ ],
+ "x-ms-enum": {
+ "name": "EmailChannelAuthMethod",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": 0,
+ "name": "Password",
+ "description": "Basic authentication."
+ },
+ {
+ "value": 1,
+ "name": "Graph",
+ "description": "Modern authentication."
+ }
+ ]
+ }
+ },
+ "OutlookChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "OutlookChannel",
+ "description": "Outlook channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
"MsTeamsChannel": {
"type": "object",
"x-ms-discriminator-value": "MsTeamsChannel",
@@ -2041,9 +2116,10 @@
"properties": {
"enableCalling": {
"type": "boolean",
- "description": "Enable calling for Microsoft Teams channel"
+ "description": "Enable calling for Microsoft Teams channel",
+ "default": false
},
- "callingWebHook": {
+ "callingWebhook": {
"type": "string",
"description": "Webhook for Microsoft Teams channel calls"
},
@@ -2057,11 +2133,14 @@
},
"deploymentEnvironment": {
"type": "string",
- "description": "Deployment environment for Microsoft Teams channel calls"
+ "description": "Deployment environment for Microsoft Teams channel calls",
+ "default": "FallbackDeploymentEnvironment"
},
"acceptedTerms": {
"type": "boolean",
- "description": "Whether this channel accepted terms"
+ "description": "Whether this channel accepted terms",
+ "x-nullable": true,
+ "default": null
}
},
"description": "The parameters to provide for the Microsoft Teams channel.",
@@ -2101,7 +2180,8 @@
},
"enableCalling": {
"type": "boolean",
- "description": "Enable calling for Skype channel"
+ "description": "Enable calling for Skype channel",
+ "default": false
},
"enableScreenSharing": {
"type": "boolean",
@@ -2235,6 +2315,16 @@
},
"description": "The list of Direct Line sites"
},
+ "extensionKey1": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "default": ""
+ },
+ "extensionKey2": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "default": ""
+ },
"DirectLineEmbedCode": {
"type": "string",
"description": "Direct Line embed code of the resource"
@@ -2378,7 +2468,8 @@
},
"registerBeforeOAuthFlow": {
"type": "boolean",
- "description": "Whether to register the settings before OAuth validation is performed. Recommended to True."
+ "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.",
+ "readOnly": true
},
"IsValidated": {
"type": "boolean",
@@ -2482,14 +2573,20 @@
},
"DirectLineSpeechChannelProperties": {
"properties": {
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service id with this channel registration."
+ },
"cognitiveServiceRegion": {
"type": "string",
- "description": "The cognitive service region with this channel registration."
+ "description": "The cognitive service region with this channel registration.",
+ "x-nullable": true
},
"cognitiveServiceSubscriptionKey": {
"x-ms-secret": true,
"type": "string",
- "description": "The cognitive service subscription key to use with this channel registration."
+ "description": "The cognitive service subscription key to use with this channel registration.",
+ "x-nullable": true
},
"isEnabled": {
"type": "boolean",
@@ -2508,10 +2605,106 @@
"description": "Make this a default bot for chosen cognitive service account."
}
},
- "description": "The parameters to provide for the DirectLine Speech channel.",
- "required": [
- "cognitiveServiceRegion",
- "cognitiveServiceSubscriptionKey"
+ "description": "The parameters to provide for the DirectLine Speech channel."
+ },
+ "Omnichannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "Omnichannel",
+ "description": "Omnichannel channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "TelephonyChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "TelephonyChannel",
+ "description": "Telephony channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TelephonyChannelProperties",
+ "description": "The set of properties specific to Telephony channel resource"
+ }
+ }
+ },
+ "TelephonyChannelProperties": {
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyPhoneNumbers"
+ },
+ "description": "The list of Telephony phone numbers"
+ },
+ "apiConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyChannelResourceApiConfiguration"
+ },
+ "description": "The list of Telephony api configuration"
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the channel",
+ "x-nullable": true
+ },
+ "premiumSKU": {
+ "type": "string",
+ "description": "The premium SKU applied to the channel",
+ "x-nullable": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether the channel is enabled"
+ }
+ },
+ "description": "The parameters to provide for the Direct Line channel."
+ },
+ "AcsChatChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "AcsChatChannel",
+ "description": "AcsChat channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "SearchAssistant": {
+ "type": "object",
+ "x-ms-discriminator-value": "SearchAssistant",
+ "description": "SearchAssistant definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "M365Extensions": {
+ "type": "object",
+ "x-ms-discriminator-value": "M365Extensions",
+ "description": "M365 Extensions definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
]
},
"ChannelResponseList": {
@@ -2532,7 +2725,35 @@
"description": "The list of bot service channel operation response."
},
"WebChatSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "required": [
+ "isWebchatPreviewEnabled"
+ ],
+ "description": "A site for the Webchat channel"
+ },
+ "DirectLineSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "description": "A site for the Direct Line channel",
+ "required": [
+ "isV1Enabled",
+ "isV3Enabled"
+ ]
+ },
+ "Site": {
+ "type": "object",
"properties": {
+ "tenantId": {
+ "type": "string",
+ "description": "Tenant Id"
+ },
"siteId": {
"type": "string",
"description": "Site Id",
@@ -2543,7 +2764,11 @@
},
"siteName": {
"type": "string",
- "description": "Site name"
+ "description": "Site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2565,112 +2790,86 @@
"type": "boolean",
"description": "Whether this site is enabled for DirectLine channel"
},
- "isWebchatPreviewEnabled": {
+ "isTokenEnabled": {
"type": "boolean",
- "description": "Whether this site is enabled for preview versions of Webchat",
- "default": false
- }
- },
- "required": [
- "siteName",
- "isEnabled",
- "isWebchatPreviewEnabled"
- ],
- "description": "A site for the Webchat channel"
- },
- "DirectLineSite": {
- "properties": {
- "siteId": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Site Id",
+ "description": "Whether this site is token enabled for channel",
"readOnly": true
},
- "siteName": {
- "type": "string",
- "description": "Site name"
+ "isEndpointParametersEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is EndpointParameters enabled for channel"
},
- "key": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.",
- "readOnly": true
+ "isDetailedLoggingEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is disabled detailed logging for"
},
- "key2": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.",
- "readOnly": true
+ "isBlockUserUploadEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for block user upload.",
+ "x-nullable": true,
+ "default": null
},
- "isEnabled": {
+ "isNoStorageEnabled": {
"type": "boolean",
- "description": "Whether this site is enabled for DirectLine channel."
+ "description": "Whether this no-storage site is disabled detailed logging for"
+ },
+ "eTag": {
+ "type": "string",
+ "description": "Entity Tag"
+ },
+ "appId": {
+ "type": "string",
+ "description": "DirectLine application id"
},
"isV1Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V1 protocol.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"isV3Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V3 protocol."
},
"isSecureSiteEnabled": {
"type": "boolean",
"description": "Whether this site is enabled for authentication with Bot Framework."
},
- "isBlockUserUploadEnabled": {
- "type": "boolean",
- "description": "Whether this site is enabled for block user upload."
- },
"trustedOrigins": {
"type": "array",
"description": "List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.",
"items": {
"type": "string"
}
+ },
+ "isWebChatSpeechEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Webchat Speech",
+ "default": false
+ },
+ "isWebchatPreviewEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for preview versions of Webchat",
+ "default": false
}
},
- "description": "A site for the Direct Line channel",
"required": [
- "isV1Enabled",
- "isV3Enabled",
"isEnabled",
"siteName"
- ]
- },
- "Site": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/WebChatSite"
- },
- {
- "$ref": "#/definitions/DirectLineSite"
- }
],
- "properties": {
- "isTokenEnabled": {
- "type": "boolean",
- "description": "Whether this site is token enabled for channel"
- },
- "eTag": {
- "type": "string",
- "description": "Entity Tag"
- }
- },
"description": "A site for the channel"
},
"SiteInfo": {
"properties": {
"siteName": {
"type": "string",
- "description": "The site name"
+ "description": "The site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2692,6 +2891,95 @@
"key"
]
},
+ "TelephonyPhoneNumbers": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The element id."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "description": "The phone number."
+ },
+ "acsEndpoint": {
+ "type": "string",
+ "description": "The endpoint of ACS.",
+ "x-nullable": true
+ },
+ "acsSecret": {
+ "type": "string",
+ "description": "The secret of ACS.",
+ "x-nullable": true
+ },
+ "acsResourceId": {
+ "type": "string",
+ "description": "The resource id of ACS.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The subscription key of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The service region of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The resource id of cognitive service.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the phone number.",
+ "x-nullable": true
+ },
+ "offerType": {
+ "type": "string",
+ "description": "Optional Property that will determine the offering type of the phone.",
+ "x-nullable": true
+ }
+ },
+ "description": "A telephone number for the Telephony channel"
+ },
+ "TelephonyChannelResourceApiConfiguration": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The id of config."
+ },
+ "providerName": {
+ "type": "string",
+ "description": "The provider name.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The cognitive service subscription key.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The cognitive service region.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service resourceId.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale.",
+ "x-nullable": true
+ }
+ },
+ "description": "A resource Api configuration for the Telephony channel"
+ },
"ConnectionItemName": {
"properties": {
"name": {
@@ -2718,14 +3006,6 @@
},
"ConnectionSettingProperties": {
"properties": {
- "id": {
- "type": "string",
- "description": "Id associated with the Connection Setting."
- },
- "name": {
- "type": "string",
- "description": "Name associated with the Connection Setting."
- },
"clientId": {
"type": "string",
"description": "Client Id associated with the Connection Setting."
@@ -2742,7 +3022,8 @@
},
"scopes": {
"type": "string",
- "description": "Scopes associated with the Connection Setting"
+ "description": "Scopes associated with the Connection Setting",
+ "default": ""
},
"serviceProviderId": {
"type": "string",
@@ -2881,18 +3162,18 @@
},
"serviceProviderName": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "Name of the Service Provider",
"readOnly": true
},
"devPortalUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "URL of Dev Portal",
"readOnly": true
},
"iconUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
- "readOnly": true
+ "description": "The URL of icon",
+ "default": ""
},
"parameters": {
"description": "The list of parameters for the Service Provider",
@@ -3026,6 +3307,11 @@
"message": {
"description": "additional message from the bot management api showing why a bot name is not available",
"type": "string"
+ },
+ "absCode": {
+ "description": "response code from ABS",
+ "type": "string",
+ "x-ms-nullable": true
}
}
},
@@ -3182,7 +3468,12 @@
"SmsChannel",
"LineChannel",
"DirectLineSpeechChannel",
- "OutlookChannel"
+ "OutlookChannel",
+ "Omnichannel",
+ "TelephonyChannel",
+ "AcsChatChannel",
+ "SearchAssistant",
+ "M365Extensions"
],
"x-ms-enum": {
"name": "channelName",
@@ -3229,6 +3520,21 @@
},
{
"value": "OutlookChannel"
+ },
+ {
+ "value": "Omnichannel"
+ },
+ {
+ "value": "TelephonyChannel"
+ },
+ {
+ "value": "AcsChatChannel"
+ },
+ {
+ "value": "SearchAssistant"
+ },
+ {
+ "value": "M365Extensions"
}
]
},
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetAlexaChannel.json
index ec1622dbcb44..29f93aa3af53 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetAlexaChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetChannel.json
index 0b35ac00f005..5252b867068c 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetDirectLineSpeechChannel.json
index 9d436d21c838..114b6893d528 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetDirectLineSpeechChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetLineChannel.json
index 65daaf9a0f18..8c980d8641e8 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/GetLineChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannelsByBotService.json
index 32472bffa5a2..9e0aa59e542d 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannelsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListChannelsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -21,6 +22,7 @@
}
},
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "FacebookChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListConnectionsByBotService.json
index afd346cba1d5..16b514c79163 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListConnectionsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/ListConnectionsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"name": "sampleConnection",
"properties": {
"clientId": "sampleclientid",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutAlexaChannel.json
index 42e777326e0a..cac9d405c8e7 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutChannel.json
index 01a985afdab0..f4690036268a 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutDirectLineSpeechChannel.json
index 9d6e2319eb51..736843ef5242 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutEmailChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutEmailChannel.json
new file mode 100644
index 000000000000..b4c5a7373e2a
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutEmailChannel.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2021-05-01-preview",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "magicCode": "000000",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutLineChannel.json
index 3c5b039c9a8f..99617c261b10 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/PutLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateAlexaChannel.json
index 0a9b3855da88..90a5470ec2d7 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateChannel.json
index 01a985afdab0..f4690036268a 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateDirectLineSpeechChannel.json
index 9d6e2319eb51..736843ef5242 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateLineChannel.json
index 3c5b039c9a8f..99617c261b10 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/examples/UpdateLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json
index 974e0dfb111d..583a528ba4fd 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/privatelinks.json
@@ -66,6 +66,13 @@
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The provisioning state of the private endpoint connection resource."
+ },
+ "groupIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Group ids"
}
},
"required": [
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/botservice.json
index 6293b4cb6aa4..4ce01528fda6 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/botservice.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/botservice.json
@@ -1613,7 +1613,11 @@
"x-ms-enum": {
"name": "Kind",
"modelAsString": true
- }
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"Bot": {
"type": "object",
@@ -1802,7 +1806,8 @@
"schemaTransformationVersion": {
"type": "string",
"description": "The channel schema transformation version for the bot",
- "default": "0.0"
+ "x-nullable": true,
+ "default": null
},
"storageResourceId": {
"type": "string",
@@ -1940,12 +1945,12 @@
"extensionKey1": {
"type": "string",
"description": "The extensionKey1",
- "readOnly": true
+ "default": ""
},
"extensionKey2": {
"type": "string",
"description": "The extensionKey2",
- "readOnly": true
+ "default": ""
},
"sites": {
"type": "array",
@@ -1977,6 +1982,11 @@
"disableLocalAuth": {
"type": "boolean",
"description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "requireTermsAgreement": {
+ "type": "boolean",
+ "description": "Whether customer needs to agree to new terms.",
+ "x-ms-nullable": true
}
}
},
@@ -1992,7 +2002,11 @@
"etag": {
"type": "string",
"description": "Entity Tag of the resource",
- "x-nullable": true
+ "x-nullable": true,
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"provisioningState": {
"type": "string",
@@ -2426,12 +2440,12 @@
"extensionKey1": {
"type": "string",
"description": "The extensionKey1",
- "readOnly": true
+ "default": ""
},
"extensionKey2": {
"type": "string",
"description": "The extensionKey2",
- "readOnly": true
+ "default": ""
},
"DirectLineEmbedCode": {
"type": "string",
@@ -2576,7 +2590,8 @@
},
"registerBeforeOAuthFlow": {
"type": "boolean",
- "description": "Whether to register the settings before OAuth validation is performed. Recommended to True."
+ "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.",
+ "readOnly": true
},
"IsValidated": {
"type": "boolean",
@@ -2714,6 +2729,106 @@
},
"description": "The parameters to provide for the DirectLine Speech channel."
},
+ "Omnichannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "Omnichannel",
+ "description": "Omnichannel channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "TelephonyChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "TelephonyChannel",
+ "description": "Telephony channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TelephonyChannelProperties",
+ "description": "The set of properties specific to Telephony channel resource"
+ }
+ }
+ },
+ "TelephonyChannelProperties": {
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyPhoneNumbers"
+ },
+ "description": "The list of Telephony phone numbers"
+ },
+ "apiConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyChannelResourceApiConfiguration"
+ },
+ "description": "The list of Telephony api configuration"
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the channel",
+ "x-nullable": true
+ },
+ "premiumSKU": {
+ "type": "string",
+ "description": "The premium SKU applied to the channel",
+ "x-nullable": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether the channel is enabled"
+ }
+ },
+ "description": "The parameters to provide for the Direct Line channel."
+ },
+ "AcsChatChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "AcsChatChannel",
+ "description": "AcsChat channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "SearchAssistant": {
+ "type": "object",
+ "x-ms-discriminator-value": "SearchAssistant",
+ "description": "SearchAssistant definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "M365Extensions": {
+ "type": "object",
+ "x-ms-discriminator-value": "M365Extensions",
+ "description": "M365 Extensions definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
"ChannelResponseList": {
"properties": {
"nextLink": {
@@ -2757,6 +2872,10 @@
"Site": {
"type": "object",
"properties": {
+ "tenantId": {
+ "type": "string",
+ "description": "Tenant Id"
+ },
"siteId": {
"type": "string",
"description": "Site Id",
@@ -2767,7 +2886,11 @@
},
"siteName": {
"type": "string",
- "description": "Site name"
+ "description": "Site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2822,11 +2945,15 @@
},
"isV1Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V1 protocol.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"isV3Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V3 protocol."
},
"isSecureSiteEnabled": {
"type": "boolean",
@@ -2839,6 +2966,11 @@
"type": "string"
}
},
+ "isWebChatSpeechEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Webchat Speech",
+ "default": false
+ },
"isWebchatPreviewEnabled": {
"type": "boolean",
"description": "Whether this site is enabled for preview versions of Webchat",
@@ -2855,7 +2987,11 @@
"properties": {
"siteName": {
"type": "string",
- "description": "The site name"
+ "description": "The site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2877,6 +3013,95 @@
"key"
]
},
+ "TelephonyPhoneNumbers": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The element id."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "description": "The phone number."
+ },
+ "acsEndpoint": {
+ "type": "string",
+ "description": "The endpoint of ACS.",
+ "x-nullable": true
+ },
+ "acsSecret": {
+ "type": "string",
+ "description": "The secret of ACS.",
+ "x-nullable": true
+ },
+ "acsResourceId": {
+ "type": "string",
+ "description": "The resource id of ACS.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The subscription key of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The service region of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The resource id of cognitive service.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the phone number.",
+ "x-nullable": true
+ },
+ "offerType": {
+ "type": "string",
+ "description": "Optional Property that will determine the offering type of the phone.",
+ "x-nullable": true
+ }
+ },
+ "description": "A telephone number for the Telephony channel"
+ },
+ "TelephonyChannelResourceApiConfiguration": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The id of config."
+ },
+ "providerName": {
+ "type": "string",
+ "description": "The provider name.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The cognitive service subscription key.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The cognitive service region.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service resourceId.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale.",
+ "x-nullable": true
+ }
+ },
+ "description": "A resource Api configuration for the Telephony channel"
+ },
"ConnectionItemName": {
"properties": {
"name": {
@@ -2903,14 +3128,6 @@
},
"ConnectionSettingProperties": {
"properties": {
- "id": {
- "type": "string",
- "description": "Id associated with the Connection Setting."
- },
- "name": {
- "type": "string",
- "description": "Name associated with the Connection Setting."
- },
"clientId": {
"type": "string",
"description": "Client Id associated with the Connection Setting."
@@ -2927,7 +3144,8 @@
},
"scopes": {
"type": "string",
- "description": "Scopes associated with the Connection Setting"
+ "description": "Scopes associated with the Connection Setting",
+ "default": ""
},
"serviceProviderId": {
"type": "string",
@@ -3066,18 +3284,18 @@
},
"serviceProviderName": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "Name of the Service Provider",
"readOnly": true
},
"devPortalUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "URL of Dev Portal",
"readOnly": true
},
"iconUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
- "readOnly": true
+ "description": "The URL of icon",
+ "default": ""
},
"parameters": {
"description": "The list of parameters for the Service Provider",
@@ -3211,6 +3429,11 @@
"message": {
"description": "additional message from the bot management api showing why a bot name is not available",
"type": "string"
+ },
+ "absCode": {
+ "description": "response code from ABS",
+ "type": "string",
+ "x-ms-nullable": true
}
}
},
@@ -3405,7 +3628,10 @@
"DirectLineSpeechChannel",
"OutlookChannel",
"Omnichannel",
- "TelephonyChannel"
+ "TelephonyChannel",
+ "AcsChatChannel",
+ "SearchAssistant",
+ "M365Extensions"
],
"x-ms-enum": {
"name": "channelName",
@@ -3458,6 +3684,15 @@
},
{
"value": "TelephonyChannel"
+ },
+ {
+ "value": "AcsChatChannel"
+ },
+ {
+ "value": "SearchAssistant"
+ },
+ {
+ "value": "M365Extensions"
}
]
},
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/CreateEmailSignInUrl.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/CreateEmailSignInUrl.json
index 4810119cf3d0..a3ed083741e8 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/CreateEmailSignInUrl.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/CreateEmailSignInUrl.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "subscription-id",
"resourceGroupName": "OneResourceGroupName",
- "api-version": "2021-05-01-preview",
+ "api-version": "2022-06-15-preview",
"resourceName": "samplebotname"
},
"responses": {
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetAlexaChannel.json
index 6dee28f9fb55..8d085432dd5e 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetAlexaChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetChannel.json
index 903050147931..f2f57297906c 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetDirectLineSpeechChannel.json
index e9305df0472b..3937d2ab4f10 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetDirectLineSpeechChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetLineChannel.json
index 49096bf7178e..e5e20406b54e 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/GetLineChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListChannelsByBotService.json
index 92bab1687c3e..b78d463e4527 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListChannelsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListChannelsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -21,6 +22,7 @@
}
},
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "FacebookChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListConnectionsByBotService.json
index ff69fc311ea2..420e426b060b 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListConnectionsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/ListConnectionsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"name": "sampleConnection",
"properties": {
"clientId": "sampleclientid",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutAlexaChannel.json
index b2582ec3f59f..6ffc78a07963 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutChannel.json
index 3ba1128e9a2f..504356e6fea0 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutDirectLineSpeechChannel.json
index b9d4cf469268..5c063a587b19 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutEmailChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutEmailChannel.json
index b4ed19abb6f0..e321131fe17e 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutEmailChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutEmailChannel.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "subscription-id",
"resourceGroupName": "OneResourceGroupName",
- "api-version": "2021-05-01-preview",
+ "api-version": "2022-06-15-preview",
"resourceName": "samplebotname",
"channelName": "EmailChannel",
"parameters": {
@@ -21,6 +21,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -34,6 +35,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutLineChannel.json
index 9a41510f45bc..b58978f4dc73 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/PutLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateAlexaChannel.json
index 22bda67df0a5..0654dfb95b9d 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateChannel.json
index 3ba1128e9a2f..504356e6fea0 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateDirectLineSpeechChannel.json
index b9d4cf469268..5c063a587b19 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateLineChannel.json
index 9a41510f45bc..b58978f4dc73 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/examples/UpdateLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/privatelinks.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/privatelinks.json
index e81d25f6fe97..580b9f6aa36f 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/privatelinks.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/privatelinks.json
@@ -66,6 +66,13 @@
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The provisioning state of the private endpoint connection resource."
+ },
+ "groupIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Group ids"
}
},
"required": [
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json
index 375ba9d9f21e..884169f825d2 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json
@@ -309,16 +309,19 @@
"description": "Creates a Channel registration for a Bot Service",
"operationId": "Channels_Create",
"x-ms-examples": {
- "Create Bot": {
+ "Create Channel": {
"$ref": "./examples/PutChannel.json"
},
- "Create Alexa Bot": {
+ "Create Alexa Channel": {
"$ref": "./examples/PutAlexaChannel.json"
},
- "Create Line Bot": {
+ "Create Email Channel": {
+ "$ref": "./examples/PutEmailChannel.json"
+ },
+ "Create Line Channel": {
"$ref": "./examples/PutLineChannel.json"
},
- "Create DirectLine Speech Bot": {
+ "Create DirectLine Speech Channel": {
"$ref": "./examples/PutDirectLineSpeechChannel.json"
}
},
@@ -376,16 +379,16 @@
"description": "Updates a Channel registration for a Bot Service",
"operationId": "Channels_Update",
"x-ms-examples": {
- "Update Bot": {
+ "Update Channel": {
"$ref": "./examples/UpdateChannel.json"
},
- "Update Alexa": {
+ "Update Alexa Channel": {
"$ref": "./examples/UpdateAlexaChannel.json"
},
- "Update Line": {
+ "Update Line Channel": {
"$ref": "./examples/UpdateLineChannel.json"
},
- "Update DirectLine Speech": {
+ "Update DirectLine Speech Channel": {
"$ref": "./examples/UpdateDirectLineSpeechChannel.json"
}
},
@@ -444,10 +447,10 @@
"description": "Deletes a Channel registration from a Bot Service",
"operationId": "Channels_Delete",
"x-ms-examples": {
- "Delete Bot": {
+ "Delete Channel": {
"$ref": "./examples/DeleteChannel.json"
},
- "Delete DirectLine Speech Bot": {
+ "Delete DirectLine Speech Channel": {
"$ref": "./examples/DeleteDirectLineSpeechChannel.json"
}
},
@@ -497,16 +500,16 @@
"description": "Returns a BotService Channel registration specified by the parameters.",
"operationId": "Channels_Get",
"x-ms-examples": {
- "Get Bot": {
+ "Get Channel": {
"$ref": "./examples/GetChannel.json"
},
- "Get Alexa Bot": {
+ "Get Alexa Channel": {
"$ref": "./examples/GetAlexaChannel.json"
},
- "Get Line Bot": {
+ "Get Line Channel": {
"$ref": "./examples/GetLineChannel.json"
},
- "Get DirectLine Speech Bot": {
+ "Get DirectLine Speech Channel": {
"$ref": "./examples/GetDirectLineSpeechChannel.json"
}
},
@@ -603,7 +606,7 @@
"description": "Returns all the Channel registrations of a particular BotService resource",
"operationId": "Channels_ListByResourceGroup",
"x-ms-examples": {
- "List Bots by Resource Group": {
+ "List Channels by Resource Group": {
"$ref": "./examples/ListChannelsByBotService.json"
}
},
@@ -818,7 +821,7 @@
"BotConnection"
],
"x-ms-examples": {
- "Update Connection Setting": {
+ "List Connection Setting With Secrets": {
"$ref": "./examples/GetConnection.json"
}
},
@@ -979,7 +982,7 @@
"BotConnection"
],
"x-ms-examples": {
- "Update Connection Setting": {
+ "Get Connection Setting": {
"$ref": "./examples/GetConnection.json"
}
},
@@ -1024,7 +1027,7 @@
"description": "Deletes a Connection Setting registration for a Bot Service",
"operationId": "BotConnection_Delete",
"x-ms-examples": {
- "Update Connection Setting": {
+ "Delete Connection Setting": {
"$ref": "./examples/DeleteConnection.json"
}
},
@@ -1247,7 +1250,11 @@
"x-ms-enum": {
"name": "Kind",
"modelAsString": true
- }
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"Bot": {
"type": "object",
@@ -1276,11 +1283,13 @@
},
"iconUrl": {
"type": "string",
- "description": "The Icon Url of the bot"
+ "description": "The Icon Url of the bot",
+ "default": ""
},
"endpoint": {
"type": "string",
- "description": "The bot's endpoint"
+ "description": "The bot's endpoint",
+ "x-nullable": true
},
"endpointVersion": {
"type": "string",
@@ -1320,11 +1329,19 @@
},
"msaAppId": {
"type": "string",
- "description": "Microsoft App Id for the bot"
+ "description": "Microsoft App Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"msaAppTenantId": {
"type": "string",
- "description": "Microsoft App Tenant Id for the bot"
+ "description": "Microsoft App Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"msaAppMSIResourceId": {
"type": "string",
@@ -1371,7 +1388,8 @@
},
"isCmekEnabled": {
"type": "boolean",
- "description": "Whether Cmek is enabled"
+ "description": "Whether Cmek is enabled",
+ "default": false
},
"cmekKeyVaultUrl": {
"type": "string",
@@ -1382,6 +1400,14 @@
"description": "The CMK encryption status",
"readOnly": true
},
+ "tenantId": {
+ "type": "string",
+ "description": "The Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
"publicNetworkAccess": {
"description": "Whether the bot is in an isolated network",
"enum": [
@@ -1418,7 +1444,8 @@
"schemaTransformationVersion": {
"type": "string",
"description": "The channel schema transformation version for the bot",
- "x-nullable": true
+ "x-nullable": true,
+ "default": null
},
"storageResourceId": {
"type": "string",
@@ -1518,11 +1545,13 @@
"properties": {
"extensionKey1": {
"type": "string",
- "description": "The extensionKey1"
+ "description": "The extensionKey1",
+ "default": ""
},
"extensionKey2": {
"type": "string",
- "description": "The extensionKey2"
+ "description": "The extensionKey2",
+ "default": ""
},
"sites": {
"type": "array",
@@ -1558,6 +1587,11 @@
"disableLocalAuth": {
"type": "boolean",
"description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "requireTermsAgreement": {
+ "type": "boolean",
+ "description": "Whether customer needs to agree to new terms.",
+ "x-ms-nullable": true
}
}
},
@@ -1573,7 +1607,11 @@
"etag": {
"type": "string",
"description": "Entity Tag of the resource",
- "x-nullable": true
+ "x-nullable": true,
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"provisioningState": {
"type": "string",
@@ -1728,10 +1766,18 @@
"type": "string",
"description": "The email address"
},
+ "authMethod": {
+ "$ref": "#/definitions/EmailChannelAuthMethod",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph."
+ },
"password": {
"type": "string",
"description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty."
},
+ "magicCode": {
+ "type": "string",
+ "description": "The magic code for setting up the modern authentication."
+ },
"isEnabled": {
"type": "boolean",
"description": "Whether this channel is enabled for the bot"
@@ -1743,6 +1789,40 @@
"isEnabled"
]
},
+ "EmailChannelAuthMethod": {
+ "type": "number",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph.",
+ "enum": [
+ 0,
+ 1
+ ],
+ "x-ms-enum": {
+ "name": "EmailChannelAuthMethod",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": 0,
+ "name": "Password",
+ "description": "Basic authentication."
+ },
+ {
+ "value": 1,
+ "name": "Graph",
+ "description": "Modern authentication."
+ }
+ ]
+ }
+ },
+ "OutlookChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "OutlookChannel",
+ "description": "Outlook channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
"MsTeamsChannel": {
"type": "object",
"x-ms-discriminator-value": "MsTeamsChannel",
@@ -1763,9 +1843,10 @@
"properties": {
"enableCalling": {
"type": "boolean",
- "description": "Enable calling for Microsoft Teams channel"
+ "description": "Enable calling for Microsoft Teams channel",
+ "default": false
},
- "callingWebHook": {
+ "callingWebhook": {
"type": "string",
"description": "Webhook for Microsoft Teams channel calls"
},
@@ -1780,12 +1861,13 @@
"deploymentEnvironment": {
"type": "string",
"description": "Deployment environment for Microsoft Teams channel calls",
- "x-nullable": true
+ "default": "FallbackDeploymentEnvironment"
},
"acceptedTerms": {
"type": "boolean",
"description": "Whether this channel accepted terms",
- "default": true
+ "x-nullable": true,
+ "default": null
}
},
"description": "The parameters to provide for the Microsoft Teams channel.",
@@ -1825,7 +1907,8 @@
},
"enableCalling": {
"type": "boolean",
- "description": "Enable calling for Skype channel"
+ "description": "Enable calling for Skype channel",
+ "default": false
},
"enableScreenSharing": {
"type": "boolean",
@@ -1965,6 +2048,16 @@
],
"description": "The list of Direct Line sites"
},
+ "extensionKey1": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "default": ""
+ },
+ "extensionKey2": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "default": ""
+ },
"DirectLineEmbedCode": {
"type": "string",
"description": "Direct Line embed code of the resource"
@@ -2088,6 +2181,10 @@
"type": "string",
"description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty."
},
+ "scopes": {
+ "type": "string",
+ "description": "The Slack permission scopes."
+ },
"landingPageUrl": {
"type": "string",
"description": "The Slack landing page Url"
@@ -2107,7 +2204,7 @@
"description": "Whether to register the settings before OAuth validation is performed. Recommended to True.",
"readOnly": true
},
- "isValidated": {
+ "IsValidated": {
"type": "boolean",
"description": "Whether this channel is validated for the bot",
"readOnly": true
@@ -2212,14 +2309,20 @@
},
"DirectLineSpeechChannelProperties": {
"properties": {
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service id with this channel registration."
+ },
"cognitiveServiceRegion": {
"type": "string",
- "description": "The cognitive service region with this channel registration."
+ "description": "The cognitive service region with this channel registration.",
+ "x-nullable": true
},
"cognitiveServiceSubscriptionKey": {
"x-ms-secret": true,
"type": "string",
- "description": "The cognitive service subscription key to use with this channel registration."
+ "description": "The cognitive service subscription key to use with this channel registration.",
+ "x-nullable": true
},
"isEnabled": {
"type": "boolean",
@@ -2238,10 +2341,106 @@
"description": "Make this a default bot for chosen cognitive service account."
}
},
- "description": "The parameters to provide for the DirectLine Speech channel.",
- "required": [
- "cognitiveServiceRegion",
- "cognitiveServiceSubscriptionKey"
+ "description": "The parameters to provide for the DirectLine Speech channel."
+ },
+ "Omnichannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "Omnichannel",
+ "description": "Omnichannel channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "TelephonyChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "TelephonyChannel",
+ "description": "Telephony channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TelephonyChannelProperties",
+ "description": "The set of properties specific to Telephony channel resource"
+ }
+ }
+ },
+ "TelephonyChannelProperties": {
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyPhoneNumbers"
+ },
+ "description": "The list of Telephony phone numbers"
+ },
+ "apiConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyChannelResourceApiConfiguration"
+ },
+ "description": "The list of Telephony api configuration"
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the channel",
+ "x-nullable": true
+ },
+ "premiumSKU": {
+ "type": "string",
+ "description": "The premium SKU applied to the channel",
+ "x-nullable": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether the channel is enabled"
+ }
+ },
+ "description": "The parameters to provide for the Direct Line channel."
+ },
+ "AcsChatChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "AcsChatChannel",
+ "description": "AcsChat channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "SearchAssistant": {
+ "type": "object",
+ "x-ms-discriminator-value": "SearchAssistant",
+ "description": "SearchAssistant definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "M365Extensions": {
+ "type": "object",
+ "x-ms-discriminator-value": "M365Extensions",
+ "description": "M365 Extensions definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
]
},
"ChannelResponseList": {
@@ -2262,7 +2461,35 @@
"description": "The list of bot service channel operation response."
},
"WebChatSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "required": [
+ "isWebchatPreviewEnabled"
+ ],
+ "description": "A site for the Webchat channel"
+ },
+ "DirectLineSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "description": "A site for the Direct Line channel",
+ "required": [
+ "isV1Enabled",
+ "isV3Enabled"
+ ]
+ },
+ "Site": {
+ "type": "object",
"properties": {
+ "tenantId": {
+ "type": "string",
+ "description": "Tenant Id"
+ },
"siteId": {
"type": "string",
"description": "Site Id",
@@ -2273,7 +2500,11 @@
},
"siteName": {
"type": "string",
- "description": "Site name"
+ "description": "Site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2295,113 +2526,86 @@
"type": "boolean",
"description": "Whether this site is enabled for DirectLine channel"
},
- "isWebchatPreviewEnabled": {
+ "isTokenEnabled": {
"type": "boolean",
- "description": "Whether this site is enabled for preview versions of Webchat",
- "default": false
- }
- },
- "required": [
- "siteName",
- "isEnabled",
- "isWebchatPreviewEnabled"
- ],
- "description": "A site for the Webchat channel"
- },
- "DirectLineSite": {
- "properties": {
- "siteId": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Site Id",
+ "description": "Whether this site is token enabled for channel",
"readOnly": true
},
- "siteName": {
- "type": "string",
- "description": "Site name"
+ "isEndpointParametersEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is EndpointParameters enabled for channel"
},
- "key": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.",
- "readOnly": true
+ "isDetailedLoggingEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is disabled detailed logging for"
},
- "key2": {
- "x-ms-mutability": [
- "read"
- ],
- "type": "string",
- "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.",
- "readOnly": true
+ "isBlockUserUploadEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for block user upload.",
+ "x-nullable": true,
+ "default": null
},
- "isEnabled": {
+ "isNoStorageEnabled": {
"type": "boolean",
- "description": "Whether this site is enabled for DirectLine channel."
+ "description": "Whether this no-storage site is disabled detailed logging for"
+ },
+ "eTag": {
+ "type": "string",
+ "description": "Entity Tag"
+ },
+ "appId": {
+ "type": "string",
+ "description": "DirectLine application id"
},
"isV1Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V1 protocol.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"isV3Enabled": {
"type": "boolean",
- "description": "Whether this site is enabled for Bot Framework V1 protocol."
+ "description": "Whether this site is enabled for Bot Framework V3 protocol."
},
"isSecureSiteEnabled": {
"type": "boolean",
"description": "Whether this site is enabled for authentication with Bot Framework."
},
- "isBlockUserUploadEnabled": {
- "type": "boolean",
- "description": "Whether this site is enabled for block user upload.",
- "x-nullable": true
- },
"trustedOrigins": {
"type": "array",
"description": "List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.",
"items": {
"type": "string"
}
+ },
+ "isWebChatSpeechEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Webchat Speech",
+ "default": false
+ },
+ "isWebchatPreviewEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for preview versions of Webchat",
+ "default": false
}
},
- "description": "A site for the Direct Line channel",
"required": [
- "isV1Enabled",
- "isV3Enabled",
"isEnabled",
"siteName"
- ]
- },
- "Site": {
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/WebChatSite"
- },
- {
- "$ref": "#/definitions/DirectLineSite"
- }
],
- "properties": {
- "isTokenEnabled": {
- "type": "boolean",
- "description": "Whether this site is token enabled for channel"
- },
- "eTag": {
- "type": "string",
- "description": "Entity Tag"
- }
- },
"description": "A site for the channel"
},
"SiteInfo": {
"properties": {
"siteName": {
"type": "string",
- "description": "The site name"
+ "description": "The site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"key": {
"type": "string",
@@ -2423,6 +2627,95 @@
"key"
]
},
+ "TelephonyPhoneNumbers": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The element id."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "description": "The phone number."
+ },
+ "acsEndpoint": {
+ "type": "string",
+ "description": "The endpoint of ACS.",
+ "x-nullable": true
+ },
+ "acsSecret": {
+ "type": "string",
+ "description": "The secret of ACS.",
+ "x-nullable": true
+ },
+ "acsResourceId": {
+ "type": "string",
+ "description": "The resource id of ACS.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The subscription key of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The service region of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The resource id of cognitive service.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the phone number.",
+ "x-nullable": true
+ },
+ "offerType": {
+ "type": "string",
+ "description": "Optional Property that will determine the offering type of the phone.",
+ "x-nullable": true
+ }
+ },
+ "description": "A telephone number for the Telephony channel"
+ },
+ "TelephonyChannelResourceApiConfiguration": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The id of config."
+ },
+ "providerName": {
+ "type": "string",
+ "description": "The provider name.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The cognitive service subscription key.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The cognitive service region.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service resourceId.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale.",
+ "x-nullable": true
+ }
+ },
+ "description": "A resource Api configuration for the Telephony channel"
+ },
"ConnectionItemName": {
"properties": {
"name": {
@@ -2449,14 +2742,6 @@
},
"ConnectionSettingProperties": {
"properties": {
- "id": {
- "type": "string",
- "description": "Id associated with the Connection Setting."
- },
- "name": {
- "type": "string",
- "description": "Name associated with the Connection Setting."
- },
"clientId": {
"type": "string",
"description": "Client Id associated with the Connection Setting."
@@ -2473,7 +2758,8 @@
},
"scopes": {
"type": "string",
- "description": "Scopes associated with the Connection Setting"
+ "description": "Scopes associated with the Connection Setting",
+ "default": ""
},
"serviceProviderId": {
"type": "string",
@@ -2618,18 +2904,18 @@
},
"serviceProviderName": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "Name of the Service Provider",
"readOnly": true
},
"devPortalUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
+ "description": "URL of Dev Portal",
"readOnly": true
},
"iconUrl": {
"type": "string",
- "description": "Display Name of the Service Provider",
- "readOnly": true
+ "description": "The URL of icon",
+ "default": ""
},
"parameters": {
"description": "The list of parameters for the Service Provider",
@@ -2770,6 +3056,11 @@
"message": {
"description": "additional message from the bot management api showing why a bot name is not available",
"type": "string"
+ },
+ "absCode": {
+ "description": "response code from ABS",
+ "type": "string",
+ "x-ms-nullable": true
}
}
},
@@ -2879,7 +3170,13 @@
"DirectLineChannel",
"SmsChannel",
"LineChannel",
- "DirectLineSpeechChannel"
+ "DirectLineSpeechChannel",
+ "OutlookChannel",
+ "Omnichannel",
+ "TelephonyChannel",
+ "AcsChatChannel",
+ "SearchAssistant",
+ "M365Extensions"
],
"x-ms-enum": {
"name": "channelName",
@@ -2923,6 +3220,24 @@
},
{
"value": "DirectLineSpeechChannel"
+ },
+ {
+ "value": "OutlookChannel"
+ },
+ {
+ "value": "Omnichannel"
+ },
+ {
+ "value": "TelephonyChannel"
+ },
+ {
+ "value": "AcsChatChannel"
+ },
+ {
+ "value": "SearchAssistant"
+ },
+ {
+ "value": "M365Extensions"
}
]
},
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetAlexaChannel.json
index ce8e6dd0c0cc..0f5d1fd4e01c 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetAlexaChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetChannel.json
index b89f02010de6..007f8122b6d6 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json
index 35110c6719ff..08e3ffe9226c 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetLineChannel.json
index 8ea4e7ac3b97..c56b44aaa147 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetLineChannel.json
@@ -9,6 +9,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListChannelsByBotService.json
index 30af210a3ad4..3990ee25724b 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListChannelsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListChannelsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -21,6 +22,7 @@
}
},
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "FacebookChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListConnectionsByBotService.json
index 24f10ec90b1a..b5aed59885e5 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListConnectionsByBotService.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/ListConnectionsByBotService.json
@@ -10,6 +10,7 @@
"body": {
"value": [
{
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"name": "sampleConnection",
"properties": {
"clientId": "sampleclientid",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutAlexaChannel.json
index 8bea9a75068f..28521c28ebf6 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutChannel.json
index 0db6722e455b..c78f7b150bce 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json
index 0411ec285694..08c0385af9e2 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutEmailChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutEmailChannel.json
new file mode 100644
index 000000000000..1a591355a35a
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutEmailChannel.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2021-03-01",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "magicCode": "000000",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutLineChannel.json
index 33ba5d33aabd..5729f0b443fb 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateAlexaChannel.json
index 86267a4b33ad..980ba269d940 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateAlexaChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateAlexaChannel.json
@@ -19,6 +19,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "AlexaChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateChannel.json
index 0db6722e455b..c78f7b150bce 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
@@ -33,6 +34,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "EmailChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json
index 0411ec285694..08c0385af9e2 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json
@@ -20,6 +20,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
@@ -32,6 +33,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "DirectLineSpeechChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateLineChannel.json
index 33ba5d33aabd..5729f0b443fb 100644
--- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateLineChannel.json
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateLineChannel.json
@@ -23,6 +23,7 @@
"responses": {
"200": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
@@ -42,6 +43,7 @@
},
"201": {
"body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
"location": "global",
"properties": {
"channelName": "LineChannel",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json
new file mode 100644
index 000000000000..37a4687071f1
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json
@@ -0,0 +1,3725 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure Bot Service",
+ "description": "Azure Bot Service is a platform for creating smart conversational agents.",
+ "version": "2022-09-15"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": {
+ "put": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.",
+ "operationId": "Bots_Create",
+ "x-ms-examples": {
+ "Create Bot": {
+ "$ref": "./examples/CreateBot.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ },
+ "description": "The parameters to provide for the created bot."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is created successfully or already existed, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ }
+ },
+ "201": {
+ "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Updates a Bot Service",
+ "operationId": "Bots_Update",
+ "x-ms-examples": {
+ "Update Bot": {
+ "$ref": "./examples/UpdateBot.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "x-ms-client-flatten": true,
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ },
+ "description": "The parameters to provide for the created bot."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ }
+ },
+ "201": {
+ "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Deletes a Bot Service from the resource group. ",
+ "operationId": "Bots_Delete",
+ "x-ms-examples": {
+ "Delete Bot": {
+ "$ref": "./examples/DeleteBot.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;"
+ },
+ "204": {
+ "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Returns a BotService specified by the parameters.",
+ "operationId": "Bots_Get",
+ "x-ms-examples": {
+ "Get Bot": {
+ "$ref": "./examples/GetBot.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/Bot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": {
+ "get": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Returns all the resources of a particular type belonging to a resource group",
+ "operationId": "Bots_ListByResourceGroup",
+ "x-ms-examples": {
+ "List Bots by Resource Group": {
+ "$ref": "./examples/ListBotsByResourceGroup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.",
+ "schema": {
+ "$ref": "#/definitions/BotResponseList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": {
+ "get": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Returns all the resources of a particular type belonging to a subscription.",
+ "operationId": "Bots_List",
+ "x-ms-examples": {
+ "List Bots by Subscription": {
+ "$ref": "./examples/ListBotsBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ",
+ "schema": {
+ "$ref": "#/definitions/BotResponseList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}": {
+ "put": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Creates a Channel registration for a Bot Service",
+ "operationId": "Channels_Create",
+ "x-ms-examples": {
+ "Create Channel": {
+ "$ref": "./examples/PutChannel.json"
+ },
+ "Create Alexa Channel": {
+ "$ref": "./examples/PutAlexaChannel.json"
+ },
+ "Create Email Channel": {
+ "$ref": "./examples/PutEmailChannel.json"
+ },
+ "Create Line Channel": {
+ "$ref": "./examples/PutLineChannel.json"
+ },
+ "Create DirectLine Speech Channel": {
+ "$ref": "./examples/PutDirectLineSpeechChannel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/channelNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ },
+ "description": "The parameters to provide for the created bot."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is created successfully or already existed, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "201": {
+ "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Updates a Channel registration for a Bot Service",
+ "operationId": "Channels_Update",
+ "x-ms-examples": {
+ "Update Channel": {
+ "$ref": "./examples/UpdateChannel.json"
+ },
+ "Update Alexa Channel": {
+ "$ref": "./examples/UpdateAlexaChannel.json"
+ },
+ "Update Line Channel": {
+ "$ref": "./examples/UpdateLineChannel.json"
+ },
+ "Update DirectLine Speech Channel": {
+ "$ref": "./examples/UpdateDirectLineSpeechChannel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/channelNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "x-ms-client-flatten": true,
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ },
+ "description": "The parameters to provide for the created bot."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "201": {
+ "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Deletes a Channel registration from a Bot Service",
+ "operationId": "Channels_Delete",
+ "x-ms-examples": {
+ "Delete Channel": {
+ "$ref": "./examples/DeleteChannel.json"
+ },
+ "Delete DirectLine Speech Channel": {
+ "$ref": "./examples/DeleteDirectLineSpeechChannel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "name": "channelName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
+ "description": "The name of the Bot resource."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;"
+ },
+ "204": {
+ "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Returns a BotService Channel registration specified by the parameters.",
+ "operationId": "Channels_Get",
+ "x-ms-examples": {
+ "Get Channel": {
+ "$ref": "./examples/GetChannel.json"
+ },
+ "Get Alexa Channel": {
+ "$ref": "./examples/GetAlexaChannel.json"
+ },
+ "Get Line Channel": {
+ "$ref": "./examples/GetLineChannel.json"
+ },
+ "Get DirectLine Speech Channel": {
+ "$ref": "./examples/GetDirectLineSpeechChannel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "name": "channelName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
+ "description": "The name of the Bot resource."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys": {
+ "post": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Lists a Channel registration for a Bot Service including secrets",
+ "operationId": "Channels_ListWithKeys",
+ "x-ms-examples": {
+ "List Channel": {
+ "$ref": "./examples/ListChannel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/channelNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is retrieved successfully, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/ListChannelWithKeysResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels": {
+ "get": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Returns all the Channel registrations of a particular BotService resource",
+ "operationId": "Channels_ListByResourceGroup",
+ "x-ms-examples": {
+ "List Channels by Resource Group": {
+ "$ref": "./examples/ListChannelsByBotService.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.",
+ "schema": {
+ "$ref": "#/definitions/ChannelResponseList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys": {
+ "post": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource",
+ "operationId": "DirectLine_RegenerateKeys",
+ "x-ms-examples": {
+ "Regenerate Keys for DirectLine Channel Site": {
+ "$ref": "./examples/DirectlineRegenerateKeys.json"
+ },
+ "Regenerate Keys for WebChat Channel Site": {
+ "$ref": "./examples/WebChatRegenerateKeys.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/regenerateKeyschannelNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteInfo"
+ },
+ "description": "The parameters to provide for the created bot."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.",
+ "schema": {
+ "$ref": "#/definitions/BotChannel"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/createEmailSignInUrl": {
+ "post": {
+ "tags": [
+ "Channel"
+ ],
+ "description": "Creates an email channel sign in url for a Bot Service",
+ "operationId": "Email_CreateSignInUrl",
+ "x-ms-examples": {
+ "Create Url": {
+ "$ref": "./examples/CreateEmailSignInUrl.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If url is created successfully, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/CreateEmailSignInUrlResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.BotService/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "Bot"
+ ],
+ "description": "Check whether a bot name is available.",
+ "operationId": "Bots_GetCheckNameAvailability",
+ "x-ms-examples": {
+ "check Name Availability": {
+ "$ref": "./examples/CheckNameAvailability.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityRequestBody"
+ },
+ "description": "The request body parameters to provide for the check name availability request"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResponseBody"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.BotService/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all the available BotService operations.",
+ "operationId": "Operations_List",
+ "x-ms-examples": {
+ "Get Operations": {
+ "$ref": "./examples/GetOperations.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/OperationEntityListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders": {
+ "post": {
+ "tags": [
+ "ListServiceProviders"
+ ],
+ "description": "Lists the available Service Providers for creating Connection Settings",
+ "operationId": "BotConnection_ListServiceProviders",
+ "x-ms-examples": {
+ "List Auth Service Providers": {
+ "$ref": "./examples/ListServiceProviders.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is retrieved successfully, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/ServiceProviderResponseList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listQnAMakerEndpointKeys": {
+ "post": {
+ "tags": [
+ "ListQnAMakerEndpointKeys"
+ ],
+ "description": "Lists the QnA Maker endpoint keys",
+ "operationId": "QnAMakerEndpointKeys_Get",
+ "x-ms-examples": {
+ "List QnAMaker Endpoint Keys": {
+ "$ref": "./examples/ListQnAMakerEndpointKeys.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QnAMakerEndpointKeysRequestBody"
+ },
+ "description": "The request body parameters to provide for the check name availability request"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is retrieved successfully, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/QnAMakerEndpointKeysResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets": {
+ "post": {
+ "tags": [
+ "BotConnection"
+ ],
+ "x-ms-examples": {
+ "List Connection Setting With Secrets": {
+ "$ref": "./examples/GetConnection.json"
+ }
+ },
+ "description": "Get a Connection Setting registration for a Bot Service",
+ "operationId": "BotConnection_ListWithSecrets",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/connectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}": {
+ "put": {
+ "tags": [
+ "BotConnection"
+ ],
+ "description": "Register a new Auth Connection for a Bot Service",
+ "operationId": "BotConnection_Create",
+ "x-ms-examples": {
+ "Create Connection Setting": {
+ "$ref": "./examples/PutConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/connectionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ },
+ "description": "The parameters to provide for creating the Connection Setting."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is created successfully or already existed, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "201": {
+ "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BotConnection"
+ ],
+ "description": "Updates a Connection Setting registration for a Bot Service",
+ "operationId": "BotConnection_Update",
+ "x-ms-examples": {
+ "Update Connection Setting": {
+ "$ref": "./examples/UpdateConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/connectionNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ },
+ "description": "The parameters to provide for updating the Connection Setting."
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is created successfully or already existed, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "201": {
+ "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "BotConnection"
+ ],
+ "x-ms-examples": {
+ "Get Connection Setting": {
+ "$ref": "./examples/GetConnection.json"
+ }
+ },
+ "description": "Get a Connection Setting registration for a Bot Service",
+ "operationId": "BotConnection_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/connectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSetting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BotConnection"
+ ],
+ "description": "Deletes a Connection Setting registration for a Bot Service",
+ "operationId": "BotConnection_Delete",
+ "x-ms-examples": {
+ "Delete Connection Setting": {
+ "$ref": "./examples/DeleteConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/connectionNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;"
+ },
+ "204": {
+ "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections": {
+ "get": {
+ "tags": [
+ "BotConnection"
+ ],
+ "description": "Returns all the Connection Settings registered to a particular BotService resource",
+ "operationId": "BotConnection_ListByBotService",
+ "x-ms-examples": {
+ "List Connection Settings": {
+ "$ref": "./examples/ListConnectionsByBotService.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.",
+ "schema": {
+ "$ref": "#/definitions/ConnectionSettingResponseList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/hostSettings": {
+ "get": {
+ "tags": [
+ "BotHostSettings"
+ ],
+ "description": "Get per subscription settings needed to host bot in compute resource such as Azure App Service",
+ "operationId": "HostSettings_Get",
+ "x-ms-examples": {
+ "Get Bot Host Settings": {
+ "$ref": "./examples/GetHostSettings.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If resource is retrieved successfully, the service should return 200 (OK).",
+ "schema": {
+ "$ref": "#/definitions/HostSettingsResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/operationresults/{operationResultId}": {
+ "get": {
+ "tags": [
+ "OperationResults"
+ ],
+ "description": "Get the operation result for a long running operation.",
+ "operationId": "OperationResults_Get",
+ "x-ms-examples": {
+ "Get operation result": {
+ "$ref": "./examples/OperationResultsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/operationResultIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The body contains all of the properties of the operation result.",
+ "schema": {
+ "$ref": "#/definitions/OperationResultsDescription"
+ }
+ },
+ "202": {
+ "description": "Accepted - Get request accepted; the operation will complete asynchronously."
+ },
+ "default": {
+ "description": "Default error response",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_List",
+ "description": "List all the private endpoint connections associated with the Bot.",
+ "x-ms-examples": {
+ "List Private Endpoint Connections": {
+ "$ref": "./examples/ListPrivateEndpointConnections.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Successfully retrieved private endpoint connections.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "Default error response",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Get",
+ "description": "Gets the specified private endpoint connection associated with the Bot.",
+ "x-ms-examples": {
+ "Get Private Endpoint Connection": {
+ "$ref": "./examples/GetPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Get the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Create",
+ "description": "Update the state of specified private endpoint connection associated with the Bot.",
+ "x-ms-examples": {
+ "Put Private Endpoint Connection": {
+ "$ref": "./examples/PutPrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "name": "properties",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ },
+ "description": "The private endpoint connection properties."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Update the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Delete",
+ "description": "Deletes the specified private endpoint connection associated with the Bot.",
+ "x-ms-examples": {
+ "Delete Private Endpoint Connection": {
+ "$ref": "./examples/DeletePrivateEndpointConnection.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Delete the private endpoint connection successfully."
+ },
+ "204": {
+ "description": "No Content -- The private endpoint connection does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_ListByBotResource",
+ "description": "Gets the private link resources that need to be created for a Bot.",
+ "x-ms-examples": {
+ "List Private Link Resources": {
+ "$ref": "./examples/ListPrivateLinkResources.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved private link resources.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateLinkResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Default error response",
+ "x-ms-error-response": true,
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Resource": {
+ "description": "Azure resource",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "id": {
+ "description": "Specifies the resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Specifies the name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Specifies the location of the resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Specifies the type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tags": {
+ "description": "Contains resource tags defined as key/value pairs.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "Gets or sets the SKU of the resource."
+ },
+ "kind": {
+ "$ref": "#/definitions/Kind",
+ "description": "Required. Gets or sets the Kind of the resource.",
+ "x-nullable": true
+ },
+ "etag": {
+ "type": "string",
+ "description": "Entity Tag"
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Entity zones",
+ "readOnly": true
+ }
+ }
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/SkuName",
+ "description": "The sku name"
+ },
+ "tier": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Gets the sku tier. This is based on the SKU name.",
+ "enum": [
+ "Free",
+ "Standard"
+ ],
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "The SKU of the cognitive services account."
+ },
+ "SkuName": {
+ "type": "string",
+ "description": "The name of SKU.",
+ "enum": [
+ "F0",
+ "S1"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "Kind": {
+ "type": "string",
+ "description": "Indicates the type of bot service",
+ "enum": [
+ "sdk",
+ "designer",
+ "bot",
+ "function",
+ "azurebot"
+ ],
+ "x-ms-enum": {
+ "name": "Kind",
+ "modelAsString": true
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "Bot": {
+ "type": "object",
+ "description": "Bot resource definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BotProperties",
+ "description": "The set of properties specific to bot resource"
+ }
+ }
+ },
+ "BotProperties": {
+ "properties": {
+ "displayName": {
+ "type": "string",
+ "description": "The Name of the bot"
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the bot"
+ },
+ "iconUrl": {
+ "type": "string",
+ "description": "The Icon Url of the bot",
+ "default": ""
+ },
+ "endpoint": {
+ "type": "string",
+ "description": "The bot's endpoint",
+ "x-nullable": true
+ },
+ "endpointVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The bot's endpoint version"
+ },
+ "allSettings": {
+ "description": "Contains resource all settings defined as key/value pairs.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "parameters": {
+ "description": "Contains resource parameters defined as key/value pairs.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "manifestUrl": {
+ "type": "string",
+ "description": "The bot's manifest url"
+ },
+ "msaAppType": {
+ "type": "string",
+ "description": "Microsoft App Type for the bot",
+ "enum": [
+ "UserAssignedMSI",
+ "SingleTenant",
+ "MultiTenant"
+ ],
+ "x-ms-enum": {
+ "name": "msaAppType",
+ "modelAsString": true
+ }
+ },
+ "msaAppId": {
+ "type": "string",
+ "description": "Microsoft App Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "msaAppTenantId": {
+ "type": "string",
+ "description": "Microsoft App Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "msaAppMSIResourceId": {
+ "type": "string",
+ "description": "Microsoft App Managed Identity Resource Id for the bot"
+ },
+ "configuredChannels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "description": "Collection of channels for which the bot is configured"
+ },
+ "enabledChannels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "description": "Collection of channels for which the bot is enabled"
+ },
+ "developerAppInsightKey": {
+ "type": "string",
+ "description": "The Application Insights key"
+ },
+ "developerAppInsightsApiKey": {
+ "type": "string",
+ "description": "The Application Insights Api Key"
+ },
+ "developerAppInsightsApplicationId": {
+ "type": "string",
+ "description": "The Application Insights App Id"
+ },
+ "luisAppIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Collection of LUIS App Ids"
+ },
+ "luisKey": {
+ "type": "string",
+ "description": "The LUIS Key"
+ },
+ "isCmekEnabled": {
+ "type": "boolean",
+ "description": "Whether Cmek is enabled",
+ "default": false
+ },
+ "cmekKeyVaultUrl": {
+ "type": "string",
+ "description": "The CMK Url"
+ },
+ "cmekEncryptionStatus": {
+ "type": "string",
+ "description": "The CMK encryption status",
+ "readOnly": true
+ },
+ "tenantId": {
+ "type": "string",
+ "description": "The Tenant Id for the bot",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "publicNetworkAccess": {
+ "description": "Whether the bot is in an isolated network",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "default": "Enabled"
+ },
+ "isStreamingSupported": {
+ "type": "boolean",
+ "description": "Whether the bot is streaming supported",
+ "default": false
+ },
+ "isDeveloperAppInsightsApiKeySet": {
+ "type": "boolean",
+ "description": "Whether the bot is developerAppInsightsApiKey set",
+ "readOnly": true
+ },
+ "migrationToken": {
+ "type": "string",
+ "description": "Token used to migrate non Azure bot to azure subscription",
+ "readOnly": true
+ },
+ "disableLocalAuth": {
+ "type": "boolean",
+ "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "schemaTransformationVersion": {
+ "type": "string",
+ "description": "The channel schema transformation version for the bot",
+ "x-nullable": true,
+ "default": null
+ },
+ "storageResourceId": {
+ "type": "string",
+ "description": "The storage resourceId for the bot"
+ },
+ "privateEndpointConnections": {
+ "type": "array",
+ "readOnly": true,
+ "description": "List of Private Endpoint Connections configured for the bot",
+ "items": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "openWithHint": {
+ "type": "string",
+ "description": "The hint to browser (e.g. protocol handler) on how to open the bot for authoring"
+ },
+ "appPasswordHint": {
+ "type": "string",
+ "description": "The hint (e.g. keyVault secret resourceId) on how to fetch the app secret"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Provisioning state of the resource"
+ },
+ "publishingCredentials": {
+ "type": "string",
+ "description": "Publishing credentials of the resource"
+ }
+ },
+ "description": "The parameters to provide for the Bot.",
+ "required": [
+ "displayName",
+ "endpoint",
+ "msaAppId"
+ ]
+ },
+ "BotResponseList": {
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of bot service resources.",
+ "type": "string"
+ },
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Bot"
+ },
+ "description": "Gets the list of bot service results and their properties."
+ }
+ },
+ "description": "The list of bot service operation response."
+ },
+ "CreateEmailSignInUrlResponse": {
+ "type": "object",
+ "description": "The ARM create email sign in url operation response.",
+ "properties": {
+ "id": {
+ "description": "Specifies the resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Specifies the location of the resource.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/CreateEmailSignInUrlResponseProperties",
+ "description": "The set of properties specific to sign in url"
+ }
+ }
+ },
+ "CreateEmailSignInUrlResponseProperties": {
+ "type": "object",
+ "description": "The set of properties specific to sign in url",
+ "properties": {
+ "url": {
+ "description": "Sign in url.",
+ "type": "string"
+ }
+ }
+ },
+ "ListChannelWithKeysResponse": {
+ "type": "object",
+ "description": "The ARM channel of list channel with keys operation response.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BotChannel"
+ }
+ ],
+ "properties": {
+ "resource": {
+ "$ref": "#/definitions/Channel",
+ "description": "The set of properties specific to bot channel resource"
+ },
+ "setting": {
+ "$ref": "#/definitions/ChannelSettings",
+ "description": "Channel settings"
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "Provisioning state of the resource"
+ },
+ "entityTag": {
+ "type": "string",
+ "description": "Entity tag of the resource"
+ },
+ "changedTime": {
+ "type": "string",
+ "description": "Changed time of the resource"
+ }
+ }
+ },
+ "BotChannel": {
+ "type": "object",
+ "description": "Bot channel resource definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/Channel",
+ "description": "The set of properties specific to bot channel resource"
+ }
+ }
+ },
+ "ChannelSettings": {
+ "type": "object",
+ "description": "Channel settings definition",
+ "properties": {
+ "extensionKey1": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "default": ""
+ },
+ "extensionKey2": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "default": ""
+ },
+ "sites": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Site"
+ },
+ "description": "The list of sites"
+ },
+ "channelId": {
+ "type": "string",
+ "description": "The channel id"
+ },
+ "channelDisplayName": {
+ "type": "string",
+ "description": "The channel display name"
+ },
+ "botId": {
+ "type": "string",
+ "description": "The bot id"
+ },
+ "botIconUrl": {
+ "type": "string",
+ "description": "The bot icon url"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ },
+ "disableLocalAuth": {
+ "type": "boolean",
+ "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
+ },
+ "requireTermsAgreement": {
+ "type": "boolean",
+ "description": "Whether customer needs to agree to new terms.",
+ "x-ms-nullable": true
+ }
+ }
+ },
+ "Channel": {
+ "type": "object",
+ "description": "Channel definition",
+ "discriminator": "channelName",
+ "properties": {
+ "channelName": {
+ "type": "string",
+ "description": "The channel name"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Entity Tag of the resource",
+ "x-nullable": true,
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Provisioning state of the resource"
+ },
+ "location": {
+ "description": "Specifies the location of the resource.",
+ "type": "string",
+ "default": "global"
+ }
+ },
+ "required": [
+ "channelName"
+ ]
+ },
+ "AlexaChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "AlexaChannel",
+ "description": "Alexa channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AlexaChannelProperties",
+ "description": "The set of properties specific to Alexa channel resource"
+ }
+ }
+ },
+ "AlexaChannelProperties": {
+ "properties": {
+ "alexaSkillId": {
+ "type": "string",
+ "description": "The Alexa skill Id"
+ },
+ "urlFragment": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Url fragment used in part of the Uri configured in Alexa"
+ },
+ "serviceEndpointUri": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Full Uri used to configured the skill in Alexa"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Alexa channel.",
+ "required": [
+ "alexaSkillId",
+ "isEnabled"
+ ]
+ },
+ "FacebookChannel": {
+ "type": "object",
+ "description": "Facebook channel definition",
+ "x-ms-discriminator-value": "FacebookChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/FacebookChannelProperties",
+ "description": "The set of properties specific to bot facebook channel"
+ }
+ }
+ },
+ "FacebookChannelProperties": {
+ "properties": {
+ "verifyToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "readOnly": true,
+ "description": "Verify token. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "pages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FacebookPage"
+ },
+ "description": "The list of Facebook pages"
+ },
+ "appId": {
+ "type": "string",
+ "description": "Facebook application id"
+ },
+ "appSecret": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "callbackUrl": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Callback Url"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Facebook channel.",
+ "required": [
+ "appId",
+ "isEnabled"
+ ]
+ },
+ "FacebookPage": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Page id"
+ },
+ "accessToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty."
+ }
+ },
+ "description": "A Facebook page for Facebook channel registration",
+ "required": [
+ "id"
+ ]
+ },
+ "EmailChannel": {
+ "type": "object",
+ "description": "Email channel definition",
+ "x-ms-discriminator-value": "EmailChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/EmailChannelProperties",
+ "description": "The set of properties specific to email channel resource"
+ }
+ }
+ },
+ "EmailChannelProperties": {
+ "properties": {
+ "emailAddress": {
+ "type": "string",
+ "description": "The email address"
+ },
+ "authMethod": {
+ "$ref": "#/definitions/EmailChannelAuthMethod",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph."
+ },
+ "password": {
+ "type": "string",
+ "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "magicCode": {
+ "type": "string",
+ "description": "The magic code for setting up the modern authentication."
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Email channel.",
+ "required": [
+ "emailAddress",
+ "isEnabled"
+ ]
+ },
+ "EmailChannelAuthMethod": {
+ "type": "number",
+ "description": "Email channel auth method. 0 Password (Default); 1 Graph.",
+ "enum": [
+ 0,
+ 1
+ ],
+ "x-ms-enum": {
+ "name": "EmailChannelAuthMethod",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": 0,
+ "name": "Password",
+ "description": "Basic authentication."
+ },
+ {
+ "value": 1,
+ "name": "Graph",
+ "description": "Modern authentication."
+ }
+ ]
+ }
+ },
+ "OutlookChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "OutlookChannel",
+ "description": "Outlook channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "MsTeamsChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "MsTeamsChannel",
+ "description": "Microsoft Teams channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MsTeamsChannelProperties",
+ "description": "The set of properties specific to Microsoft Teams channel resource"
+ }
+ }
+ },
+ "MsTeamsChannelProperties": {
+ "properties": {
+ "enableCalling": {
+ "type": "boolean",
+ "description": "Enable calling for Microsoft Teams channel",
+ "default": false
+ },
+ "callingWebhook": {
+ "type": "string",
+ "description": "Webhook for Microsoft Teams channel calls"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ },
+ "incomingCallRoute": {
+ "type": "string",
+ "description": "Webhook for Microsoft Teams channel calls"
+ },
+ "deploymentEnvironment": {
+ "type": "string",
+ "description": "Deployment environment for Microsoft Teams channel calls",
+ "default": "FallbackDeploymentEnvironment"
+ },
+ "acceptedTerms": {
+ "type": "boolean",
+ "description": "Whether this channel accepted terms",
+ "x-nullable": true,
+ "default": null
+ }
+ },
+ "description": "The parameters to provide for the Microsoft Teams channel.",
+ "required": [
+ "isEnabled"
+ ]
+ },
+ "SkypeChannel": {
+ "type": "object",
+ "description": "Skype channel definition",
+ "x-ms-discriminator-value": "SkypeChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SkypeChannelProperties",
+ "description": "The set of properties specific to Skype channel resource"
+ }
+ }
+ },
+ "SkypeChannelProperties": {
+ "properties": {
+ "enableMessaging": {
+ "type": "boolean",
+ "description": "Enable messaging for Skype channel"
+ },
+ "enableMediaCards": {
+ "type": "boolean",
+ "description": "Enable media cards for Skype channel"
+ },
+ "enableVideo": {
+ "type": "boolean",
+ "description": "Enable video for Skype channel"
+ },
+ "enableCalling": {
+ "type": "boolean",
+ "description": "Enable calling for Skype channel",
+ "default": false
+ },
+ "enableScreenSharing": {
+ "type": "boolean",
+ "description": "Enable screen sharing for Skype channel"
+ },
+ "enableGroups": {
+ "type": "boolean",
+ "description": "Enable groups for Skype channel"
+ },
+ "groupsMode": {
+ "type": "string",
+ "description": "Group mode for Skype channel"
+ },
+ "callingWebHook": {
+ "type": "string",
+ "description": "Calling web hook for Skype channel"
+ },
+ "incomingCallRoute": {
+ "type": "string",
+ "description": "Incoming call route for Skype channel"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Microsoft Teams channel.",
+ "required": [
+ "isEnabled"
+ ]
+ },
+ "KikChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "KikChannel",
+ "description": "Kik channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/KikChannelProperties",
+ "description": "The set of properties specific to Kik channel resource"
+ }
+ }
+ },
+ "KikChannelProperties": {
+ "properties": {
+ "userName": {
+ "type": "string",
+ "description": "The Kik user name"
+ },
+ "apiKey": {
+ "type": "string",
+ "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "isValidated": {
+ "type": "boolean",
+ "description": "Whether this channel is validated for the bot"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Kik channel.",
+ "required": [
+ "userName",
+ "isEnabled"
+ ]
+ },
+ "WebChatChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "WebChatChannel",
+ "description": "Web Chat channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebChatChannelProperties",
+ "description": "The set of properties specific to Web Chat channel resource"
+ }
+ }
+ },
+ "WebChatChannelProperties": {
+ "properties": {
+ "webChatEmbedCode": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read"
+ ],
+ "readOnly": true,
+ "description": "Web chat control embed code"
+ },
+ "sites": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WebChatSite"
+ },
+ "description": "The list of Web Chat sites"
+ }
+ },
+ "description": "The parameters to provide for the Web Chat channel."
+ },
+ "DirectLineChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "DirectLineChannel",
+ "description": "Direct Line channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DirectLineChannelProperties",
+ "description": "The set of properties specific to Direct Line channel resource"
+ }
+ }
+ },
+ "DirectLineChannelProperties": {
+ "properties": {
+ "sites": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DirectLineSite"
+ },
+ "description": "The list of Direct Line sites"
+ },
+ "extensionKey1": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "default": ""
+ },
+ "extensionKey2": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "default": ""
+ },
+ "DirectLineEmbedCode": {
+ "type": "string",
+ "description": "Direct Line embed code of the resource"
+ }
+ },
+ "description": "The parameters to provide for the Direct Line channel."
+ },
+ "TelegramChannel": {
+ "type": "object",
+ "description": "Telegram channel definition",
+ "x-ms-discriminator-value": "TelegramChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TelegramChannelProperties",
+ "description": "The set of properties specific to Telegram channel resource"
+ }
+ }
+ },
+ "TelegramChannelProperties": {
+ "properties": {
+ "accessToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "isValidated": {
+ "type": "boolean",
+ "description": "Whether this channel is validated for the bot"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Telegram channel.",
+ "required": [
+ "isEnabled"
+ ]
+ },
+ "SmsChannel": {
+ "type": "object",
+ "description": "Sms channel definition",
+ "x-ms-discriminator-value": "SmsChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SmsChannelProperties",
+ "description": "The set of properties specific to Sms channel resource"
+ }
+ }
+ },
+ "SmsChannelProperties": {
+ "properties": {
+ "phone": {
+ "type": "string",
+ "description": "The Sms phone"
+ },
+ "accountSID": {
+ "type": "string",
+ "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "authToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "isValidated": {
+ "type": "boolean",
+ "description": "Whether this channel is validated for the bot"
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Sms channel.",
+ "required": [
+ "phone",
+ "accountSID",
+ "isEnabled"
+ ]
+ },
+ "SlackChannel": {
+ "type": "object",
+ "description": "Slack channel definition",
+ "x-ms-discriminator-value": "SlackChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SlackChannelProperties",
+ "description": "The set of properties specific to Slack channel resource"
+ }
+ }
+ },
+ "SlackChannelProperties": {
+ "properties": {
+ "clientId": {
+ "type": "string",
+ "description": "The Slack client id"
+ },
+ "clientSecret": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "verificationToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty."
+ },
+ "scopes": {
+ "type": "string",
+ "description": "The Slack permission scopes."
+ },
+ "landingPageUrl": {
+ "type": "string",
+ "description": "The Slack landing page Url"
+ },
+ "redirectAction": {
+ "type": "string",
+ "description": "The Slack redirect action",
+ "readOnly": true
+ },
+ "lastSubmissionId": {
+ "type": "string",
+ "description": "The Sms auth token",
+ "readOnly": true
+ },
+ "registerBeforeOAuthFlow": {
+ "type": "boolean",
+ "description": "Whether to register the settings before OAuth validation is performed. Recommended to True."
+ },
+ "IsValidated": {
+ "type": "boolean",
+ "description": "Whether this channel is validated for the bot",
+ "readOnly": true
+ },
+ "signingSecret": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The Slack signing secret."
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled for the bot"
+ }
+ },
+ "description": "The parameters to provide for the Slack channel.",
+ "required": [
+ "isEnabled"
+ ]
+ },
+ "LineChannel": {
+ "type": "object",
+ "description": "Line channel definition",
+ "x-ms-discriminator-value": "LineChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/LineChannelProperties",
+ "description": "The set of properties specific to line channel resource"
+ }
+ }
+ },
+ "LineChannelProperties": {
+ "properties": {
+ "lineRegistrations": {
+ "type": "array",
+ "description": "The list of line channel registrations",
+ "items": {
+ "$ref": "#/definitions/LineRegistration"
+ }
+ },
+ "callbackUrl": {
+ "type": "string",
+ "description": "Callback Url to enter in line registration.",
+ "readOnly": true
+ },
+ "isValidated": {
+ "type": "boolean",
+ "description": "Whether this channel is validated for the bot",
+ "readOnly": true
+ }
+ },
+ "description": "The parameters to provide for the Line channel.",
+ "required": [
+ "lineRegistrations"
+ ]
+ },
+ "LineRegistration": {
+ "properties": {
+ "generatedId": {
+ "x-ms-mutability": [
+ "read"
+ ],
+ "type": "string",
+ "description": "Id generated for the line channel registration",
+ "readOnly": true
+ },
+ "channelSecret": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "Secret for the line channel registration"
+ },
+ "channelAccessToken": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "Access token for the line channel registration"
+ }
+ },
+ "description": "The properties corresponding to a line channel registration"
+ },
+ "DirectLineSpeechChannel": {
+ "type": "object",
+ "description": "DirectLine Speech channel definition",
+ "x-ms-discriminator-value": "DirectLineSpeechChannel",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DirectLineSpeechChannelProperties",
+ "description": "The set of properties specific to DirectLine Speech channel resource"
+ }
+ }
+ },
+ "DirectLineSpeechChannelProperties": {
+ "properties": {
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service id with this channel registration."
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The cognitive service region with this channel registration.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "The cognitive service subscription key to use with this channel registration.",
+ "x-nullable": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this channel is enabled or not."
+ },
+ "customVoiceDeploymentId": {
+ "type": "string",
+ "description": "Custom speech model id (optional)."
+ },
+ "customSpeechModelId": {
+ "type": "string",
+ "description": "Custom voice deployment id (optional)."
+ },
+ "isDefaultBotForCogSvcAccount": {
+ "type": "boolean",
+ "description": "Make this a default bot for chosen cognitive service account."
+ }
+ },
+ "description": "The parameters to provide for the DirectLine Speech channel."
+ },
+ "Omnichannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "Omnichannel",
+ "description": "Omnichannel channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "TelephonyChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "TelephonyChannel",
+ "description": "Telephony channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TelephonyChannelProperties",
+ "description": "The set of properties specific to Telephony channel resource"
+ }
+ }
+ },
+ "TelephonyChannelProperties": {
+ "type": "object",
+ "properties": {
+ "phoneNumbers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyPhoneNumbers"
+ },
+ "description": "The list of Telephony phone numbers"
+ },
+ "apiConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TelephonyChannelResourceApiConfiguration"
+ },
+ "description": "The list of Telephony api configuration"
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The extensionKey1",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The extensionKey2",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the channel",
+ "x-nullable": true
+ },
+ "premiumSKU": {
+ "type": "string",
+ "description": "The premium SKU applied to the channel",
+ "x-nullable": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether the channel is enabled"
+ }
+ },
+ "description": "The parameters to provide for the Direct Line channel."
+ },
+ "AcsChatChannel": {
+ "type": "object",
+ "x-ms-discriminator-value": "AcsChatChannel",
+ "description": "AcsChat channel definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "SearchAssistant": {
+ "type": "object",
+ "x-ms-discriminator-value": "SearchAssistant",
+ "description": "SearchAssistant definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "M365Extensions": {
+ "type": "object",
+ "x-ms-discriminator-value": "M365Extensions",
+ "description": "M365 Extensions definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Channel"
+ }
+ ]
+ },
+ "ChannelResponseList": {
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of bot service channel resources.",
+ "type": "string"
+ },
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BotChannel"
+ },
+ "description": "Gets the list of bot service channel results and their properties."
+ }
+ },
+ "description": "The list of bot service channel operation response."
+ },
+ "WebChatSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "required": [
+ "isWebchatPreviewEnabled"
+ ],
+ "description": "A site for the Webchat channel"
+ },
+ "DirectLineSite": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Site"
+ }
+ ],
+ "description": "A site for the Direct Line channel",
+ "required": [
+ "isV1Enabled",
+ "isV3Enabled"
+ ]
+ },
+ "Site": {
+ "type": "object",
+ "properties": {
+ "tenantId": {
+ "type": "string",
+ "description": "Tenant Id"
+ },
+ "siteId": {
+ "type": "string",
+ "description": "Site Id",
+ "x-ms-mutability": [
+ "read"
+ ],
+ "readOnly": true
+ },
+ "siteName": {
+ "type": "string",
+ "description": "Site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "key": {
+ "type": "string",
+ "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.",
+ "x-ms-mutability": [
+ "read"
+ ],
+ "readOnly": true
+ },
+ "key2": {
+ "type": "string",
+ "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.",
+ "x-ms-mutability": [
+ "read"
+ ],
+ "readOnly": true
+ },
+ "isEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for DirectLine channel"
+ },
+ "isTokenEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is token enabled for channel",
+ "readOnly": true
+ },
+ "isEndpointParametersEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is EndpointParameters enabled for channel"
+ },
+ "isDetailedLoggingEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is disabled detailed logging for"
+ },
+ "isBlockUserUploadEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for block user upload.",
+ "x-nullable": true,
+ "default": null
+ },
+ "isNoStorageEnabled": {
+ "type": "boolean",
+ "description": "Whether this no-storage site is disabled detailed logging for"
+ },
+ "eTag": {
+ "type": "string",
+ "description": "Entity Tag"
+ },
+ "appId": {
+ "type": "string",
+ "description": "DirectLine application id"
+ },
+ "isV1Enabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Bot Framework V1 protocol.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isV3Enabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Bot Framework V3 protocol."
+ },
+ "isSecureSiteEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for authentication with Bot Framework."
+ },
+ "trustedOrigins": {
+ "type": "array",
+ "description": "List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isWebChatSpeechEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for Webchat Speech",
+ "default": false
+ },
+ "isWebchatPreviewEnabled": {
+ "type": "boolean",
+ "description": "Whether this site is enabled for preview versions of Webchat",
+ "default": false
+ }
+ },
+ "required": [
+ "isEnabled",
+ "siteName"
+ ],
+ "description": "A site for the channel"
+ },
+ "SiteInfo": {
+ "properties": {
+ "siteName": {
+ "type": "string",
+ "description": "The site name",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "key": {
+ "type": "string",
+ "description": "Determines which key is to be regenerated",
+ "enum": [
+ "key1",
+ "key2"
+ ],
+ "x-ms-enum": {
+ "name": "key",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for.",
+ "type": "object",
+ "required": [
+ "siteName",
+ "key"
+ ]
+ },
+ "TelephonyPhoneNumbers": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The element id."
+ },
+ "phoneNumber": {
+ "type": "string",
+ "description": "The phone number."
+ },
+ "acsEndpoint": {
+ "type": "string",
+ "description": "The endpoint of ACS.",
+ "x-nullable": true
+ },
+ "acsSecret": {
+ "type": "string",
+ "description": "The secret of ACS.",
+ "x-nullable": true
+ },
+ "acsResourceId": {
+ "type": "string",
+ "description": "The resource id of ACS.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The subscription key of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The service region of cognitive service.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The resource id of cognitive service.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale of the phone number.",
+ "x-nullable": true
+ },
+ "offerType": {
+ "type": "string",
+ "description": "Optional Property that will determine the offering type of the phone.",
+ "x-nullable": true
+ }
+ },
+ "description": "A telephone number for the Telephony channel"
+ },
+ "TelephonyChannelResourceApiConfiguration": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The id of config."
+ },
+ "providerName": {
+ "type": "string",
+ "description": "The provider name.",
+ "x-nullable": true
+ },
+ "cognitiveServiceSubscriptionKey": {
+ "type": "string",
+ "description": "The cognitive service subscription key.",
+ "x-nullable": true
+ },
+ "cognitiveServiceRegion": {
+ "type": "string",
+ "description": "The cognitive service region.",
+ "x-nullable": true
+ },
+ "cognitiveServiceResourceId": {
+ "type": "string",
+ "description": "The cognitive service resourceId.",
+ "x-nullable": true
+ },
+ "defaultLocale": {
+ "type": "string",
+ "description": "The default locale.",
+ "x-nullable": true
+ }
+ },
+ "description": "A resource Api configuration for the Telephony channel"
+ },
+ "ConnectionItemName": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Connection Item name that has been added in the API",
+ "readOnly": true
+ }
+ },
+ "description": "The display name of a connection Item Setting registered with the Bot"
+ },
+ "ConnectionSettingParameter": {
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key for the Connection Setting Parameter."
+ },
+ "value": {
+ "type": "string",
+ "description": "Value associated with the Connection Setting Parameter.",
+ "x-nullable": true
+ }
+ },
+ "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties"
+ },
+ "ConnectionSettingProperties": {
+ "properties": {
+ "clientId": {
+ "type": "string",
+ "description": "Client Id associated with the Connection Setting."
+ },
+ "settingId": {
+ "type": "string",
+ "description": "Setting Id set by the service for the Connection Setting.",
+ "readOnly": true
+ },
+ "clientSecret": {
+ "x-ms-secret": true,
+ "type": "string",
+ "description": "Client Secret associated with the Connection Setting"
+ },
+ "scopes": {
+ "type": "string",
+ "description": "Scopes associated with the Connection Setting",
+ "default": ""
+ },
+ "serviceProviderId": {
+ "type": "string",
+ "description": "Service Provider Id associated with the Connection Setting"
+ },
+ "serviceProviderDisplayName": {
+ "type": "string",
+ "description": "Service Provider Display Name associated with the Connection Setting"
+ },
+ "parameters": {
+ "type": "array",
+ "description": "Service Provider Parameters associated with the Connection Setting",
+ "items": {
+ "$ref": "#/definitions/ConnectionSettingParameter"
+ }
+ },
+ "provisioningState": {
+ "type": "string",
+ "description": "Provisioning state of the resource"
+ }
+ },
+ "description": "Properties for a Connection Setting Item"
+ },
+ "ConnectionSetting": {
+ "type": "object",
+ "description": "Bot channel resource definition",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ConnectionSettingProperties",
+ "description": "The set of properties specific to bot channel resource"
+ }
+ }
+ },
+ "ConnectionSettingResponseList": {
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of bot service connection setting resources.",
+ "type": "string"
+ },
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ConnectionSetting"
+ },
+ "description": "Gets the list of bot service connection settings and their properties."
+ }
+ },
+ "description": "The list of bot service connection settings response."
+ },
+ "ServiceProviderResponseList": {
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of bot service providers.",
+ "type": "string"
+ },
+ "value": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceProvider"
+ },
+ "description": "Gets the list of bot service providers and their properties."
+ }
+ },
+ "description": "The list of bot service providers response."
+ },
+ "ServiceProviderParameter": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the Service Provider",
+ "readOnly": true
+ },
+ "type": {
+ "type": "string",
+ "description": "Type of the Service Provider",
+ "readOnly": true
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Display Name of the Service Provider",
+ "readOnly": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the Service Provider",
+ "readOnly": true
+ },
+ "helpUrl": {
+ "type": "string",
+ "description": "Help Url for the Service Provider",
+ "readOnly": true
+ },
+ "default": {
+ "type": "string",
+ "description": "Default Name for the Service Provider",
+ "readOnly": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Meta data for the Service Provider",
+ "readOnly": true,
+ "properties": {
+ "constraints": {
+ "description": "the constraints of the bot meta data.",
+ "type": "object",
+ "properties": {
+ "required": {
+ "description": "Whether required the constraints of the bot meta data.",
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ }
+ },
+ "description": "Extra Parameters specific to each Service Provider"
+ },
+ "ServiceProviderProperties": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Id for Service Provider",
+ "readOnly": true
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Display Name of the Service Provider",
+ "readOnly": true
+ },
+ "serviceProviderName": {
+ "type": "string",
+ "description": "Name of the Service Provider",
+ "readOnly": true
+ },
+ "devPortalUrl": {
+ "type": "string",
+ "description": "URL of Dev Portal",
+ "readOnly": true
+ },
+ "iconUrl": {
+ "type": "string",
+ "description": "The URL of icon",
+ "default": ""
+ },
+ "parameters": {
+ "description": "The list of parameters for the Service Provider",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ServiceProviderParameter"
+ }
+ }
+ },
+ "description": "The Object used to describe a Service Provider supported by Bot Service"
+ },
+ "ServiceProvider": {
+ "type": "object",
+ "description": "Service Provider Definition",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ServiceProviderProperties",
+ "description": "The Properties of a Service Provider Object"
+ }
+ }
+ },
+ "Error": {
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorBody",
+ "description": "The error body."
+ }
+ },
+ "description": "Bot Service error object."
+ },
+ "ErrorBody": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "error code"
+ },
+ "message": {
+ "type": "string",
+ "description": "error message"
+ }
+ },
+ "description": "Bot Service error body.",
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "OperationEntityListResult": {
+ "description": "The list of bot service operation response.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of operations.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationEntity"
+ }
+ }
+ }
+ },
+ "OperationEntity": {
+ "description": "The operations supported by Bot Service Management.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayInfo",
+ "description": "The operation supported by Bot Service Management."
+ },
+ "origin": {
+ "description": "The origin of the operation.",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Additional properties.",
+ "type": "object"
+ }
+ }
+ },
+ "OperationDisplayInfo": {
+ "description": "The operation supported by Bot Service Management.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of the operation.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The action that users can perform, based on their permission level.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Service provider: Microsoft Bot Service.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed.",
+ "type": "string"
+ }
+ }
+ },
+ "CheckNameAvailabilityRequestBody": {
+ "description": "The request body for a request to Bot Service Management to check availability of a bot name.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "the name of the bot for which availability needs to be checked.",
+ "type": "string"
+ },
+ "type": {
+ "description": "the type of the bot for which availability needs to be checked",
+ "type": "string"
+ }
+ }
+ },
+ "CheckNameAvailabilityResponseBody": {
+ "description": "The response body returned for a request to Bot Service Management to check availability of a bot name.",
+ "type": "object",
+ "properties": {
+ "valid": {
+ "description": "indicates if the bot name is valid.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "additional message from the bot management api showing why a bot name is not available",
+ "type": "string"
+ },
+ "absCode": {
+ "description": "response code from ABS",
+ "type": "string",
+ "x-ms-nullable": true
+ }
+ }
+ },
+ "HostSettingsResponse": {
+ "description": "The response body returned for a request to Bot Service Management to check per subscription hostSettings",
+ "type": "object",
+ "properties": {
+ "OAuthUrl": {
+ "description": "For in-conversation bot user authentication",
+ "type": "string"
+ },
+ "ToBotFromChannelOpenIdMetadataUrl": {
+ "description": "For verifying incoming tokens from the channels",
+ "type": "string"
+ },
+ "ToBotFromChannelTokenIssuer": {
+ "description": "For verifying incoming tokens from the channels",
+ "type": "string"
+ },
+ "ToBotFromEmulatorOpenIdMetadataUrl": {
+ "description": "For verifying incoming tokens from bot emulator",
+ "type": "string"
+ },
+ "ToChannelFromBotLoginUrl": {
+ "description": "For getting access token to channels from bot host",
+ "type": "string"
+ },
+ "ToChannelFromBotOAuthScope": {
+ "description": "For getting access token to channels from bot host",
+ "type": "string"
+ },
+ "ValidateAuthority": {
+ "description": "Per cloud OAuth setting on whether authority is validated",
+ "type": "boolean"
+ },
+ "BotOpenIdMetadata": {
+ "description": "Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12",
+ "type": "string"
+ }
+ }
+ },
+ "QnAMakerEndpointKeysRequestBody": {
+ "description": "The request body for a request to Bot Service Management to list QnA Maker endpoint keys.",
+ "type": "object",
+ "properties": {
+ "hostname": {
+ "description": "the host name of the QnA Maker endpoint",
+ "type": "string"
+ },
+ "authkey": {
+ "description": "Subscription key which provides access to this API.",
+ "type": "string"
+ }
+ }
+ },
+ "QnAMakerEndpointKeysResponse": {
+ "type": "object",
+ "description": "Schema for EndpointKeys generate/refresh operations.",
+ "properties": {
+ "primaryEndpointKey": {
+ "type": "string",
+ "description": "Primary Access Key."
+ },
+ "secondaryEndpointKey": {
+ "type": "string",
+ "description": "Secondary Access Key."
+ },
+ "installedVersion": {
+ "type": "string",
+ "description": "Current version of runtime."
+ },
+ "lastStableVersion": {
+ "type": "string",
+ "description": "Latest version of runtime."
+ }
+ }
+ },
+ "OperationResultsDescription": {
+ "description": "The properties indicating the operation result of an operation on a service.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the operation returned.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation result.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the operation being performed.",
+ "enum": [
+ "Canceled",
+ "Succeeded",
+ "Failed",
+ "Requested",
+ "Running"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OperationResultStatus",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "The time that the operation was started.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "x-ms-parameter-location": "method",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
+ "description": "The name of the Bot resource group in the user subscription."
+ },
+ "resourceNameParameter": {
+ "name": "resourceName",
+ "x-ms-parameter-location": "method",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$",
+ "description": "The name of the Bot resource."
+ },
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Azure Subscription ID.",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Version of the API to be used with the client request."
+ },
+ "operationResultIdParameter": {
+ "name": "operationResultId",
+ "in": "path",
+ "description": "The ID of the operation result to get.",
+ "required": true,
+ "x-ms-parameter-location": "method",
+ "type": "string"
+ },
+ "connectionNameParameter": {
+ "name": "connectionName",
+ "x-ms-parameter-location": "method",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9][\\sa-zA-Z0-9_.-]*$",
+ "description": "The name of the Bot Service Connection Setting resource."
+ },
+ "channelNameParameter": {
+ "name": "channelName",
+ "x-ms-parameter-location": "method",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "AlexaChannel",
+ "FacebookChannel",
+ "EmailChannel",
+ "KikChannel",
+ "TelegramChannel",
+ "SlackChannel",
+ "MsTeamsChannel",
+ "SkypeChannel",
+ "WebChatChannel",
+ "DirectLineChannel",
+ "SmsChannel",
+ "LineChannel",
+ "DirectLineSpeechChannel",
+ "OutlookChannel",
+ "Omnichannel",
+ "TelephonyChannel",
+ "AcsChatChannel",
+ "SearchAssistant",
+ "M365Extensions"
+ ],
+ "x-ms-enum": {
+ "name": "channelName",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "AlexaChannel"
+ },
+ {
+ "value": "FacebookChannel"
+ },
+ {
+ "value": "EmailChannel"
+ },
+ {
+ "value": "KikChannel"
+ },
+ {
+ "value": "TelegramChannel"
+ },
+ {
+ "value": "SlackChannel"
+ },
+ {
+ "value": "MsTeamsChannel"
+ },
+ {
+ "value": "SkypeChannel"
+ },
+ {
+ "value": "WebChatChannel"
+ },
+ {
+ "value": "DirectLineChannel"
+ },
+ {
+ "value": "SmsChannel"
+ },
+ {
+ "value": "LineChannel"
+ },
+ {
+ "value": "DirectLineSpeechChannel"
+ },
+ {
+ "value": "OutlookChannel"
+ },
+ {
+ "value": "Omnichannel"
+ },
+ {
+ "value": "TelephonyChannel"
+ },
+ {
+ "value": "AcsChatChannel"
+ },
+ {
+ "value": "SearchAssistant"
+ },
+ {
+ "value": "M365Extensions"
+ }
+ ]
+ },
+ "description": "The name of the Channel resource."
+ },
+ "regenerateKeyschannelNameParameter": {
+ "name": "channelName",
+ "x-ms-parameter-location": "method",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "enum": [
+ "WebChatChannel",
+ "DirectLineChannel"
+ ],
+ "x-ms-enum": {
+ "name": "regenerateKeysChannelName",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "WebChatChannel"
+ },
+ {
+ "value": "DirectLineChannel"
+ }
+ ]
+ },
+ "description": "The name of the Channel resource for which keys are to be regenerated."
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CheckNameAvailability.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CheckNameAvailability.json
new file mode 100644
index 000000000000..fe8fe7f84cf1
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CheckNameAvailability.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-09-15",
+ "parameters": {
+ "name": "testbotname",
+ "type": "string"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "valid": true,
+ "message": "custom message from server"
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateBot.json
new file mode 100644
index 000000000000..b2e94f7a15ef
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateBot.json
@@ -0,0 +1,129 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "parameters": {
+ "location": "West US",
+ "sku": {
+ "name": "S1"
+ },
+ "etag": "etag1",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "kind": "sdk",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApiKey": "appinsightsapikey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "luisKey": "luiskey",
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "exampleappid",
+ "msaAppTenantId": "exampleapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "kind": "sdk",
+ "etag": "etag1",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "kind": "sdk",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateEmailSignInUrl.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateEmailSignInUrl.json
new file mode 100644
index 000000000000..e1920b721788
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/CreateEmailSignInUrl.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "location": "global",
+ "properties": {
+ "url": "https://token.botframework.com/api/oauth/signin?signin=XXX"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteBot.json
new file mode 100644
index 000000000000..d1ebb0eb3c6a
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteBot.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteChannel.json
new file mode 100644
index 000000000000..6b296d1623b2
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteChannel.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteConnection.json
new file mode 100644
index 000000000000..e14fdc0a6e5a
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteConnection.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "connectionName": "sampleConnection"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteDirectLineSpeechChannel.json
new file mode 100644
index 000000000000..ecbb6938ece9
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeleteDirectLineSpeechChannel.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "DirectLineSpeechChannel"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeletePrivateEndpointConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..a051abfb7b82
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DeletePrivateEndpointConnection.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "resourceName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DirectlineRegenerateKeys.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DirectlineRegenerateKeys.json
new file mode 100644
index 000000000000..eac9803896dd
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/DirectlineRegenerateKeys.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "DirectLineChannel",
+ "parameters": {
+ "siteName": "testSiteName",
+ "key": "key1"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineChannel",
+ "properties": {
+ "sites": [
+ {
+ "siteId": "abcd",
+ "siteName": "Default Site",
+ "key": "key1",
+ "key2": "key2",
+ "isEnabled": true,
+ "isV1Enabled": true,
+ "isV3Enabled": true
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetAlexaChannel.json
new file mode 100644
index 000000000000..6d73c583b547
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetAlexaChannel.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "AlexaChannel"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "alexa skill id",
+ "urlFragment": "XUrlFragmentX",
+ "serviceEndpointUri": "https://domain/XUrlFragmentX/botId",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetBot.json
new file mode 100644
index 000000000000..326885935b63
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetBot.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "kind": "sdk",
+ "etag": "etag1",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "schemaTransformationVersion": "1.0",
+ "disableLocalAuth": true,
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/privateEndpointConnections/privatelink",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.Network/privateEndpoints/privatelink"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetChannel.json
new file mode 100644
index 000000000000..24287d598ee5
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetChannel.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetConnection.json
new file mode 100644
index 000000000000..922e50704acc
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetConnection.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "connectionName": "sampleConnection"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "global",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection",
+ "etag": "etag1",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetDirectLineSpeechChannel.json
new file mode 100644
index 000000000000..0b004deae9e9
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetDirectLineSpeechChannel.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "DirectLineSpeechChannel"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "Cognitive service region",
+ "customVoiceDeploymentId": "Custom voice deployment ID",
+ "customSpeechModelId": "Custom speech model ID",
+ "isDefaultBotForCogSvcAccount": true,
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetHostSettings.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetHostSettings.json
new file mode 100644
index 000000000000..3379ce01badb
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetHostSettings.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "BotOpenIdMetadata": "https://login.botframework.com/v1/.well-known/openidconfiguration",
+ "OAuthUrl": "https://token.botframework.com/",
+ "ToBotFromChannelOpenIdMetadataUrl": "https://login.botframework.com/v1/.well-known/openidconfiguration",
+ "ToBotFromChannelTokenIssuer": "https://api.botframework.com",
+ "ToBotFromEmulatorOpenIdMetadataUrl": "https://login.microsoftonline.com/botframework.com/v2.0/.well-known/openid-configuration",
+ "ToChannelFromBotLoginUrl": "https://login.microsoftonline.com/botframework.com",
+ "ToChannelFromBotOAuthScope": "https://api.botframework.com",
+ "ValidateAuthority": true
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetLineChannel.json
new file mode 100644
index 000000000000..f7f8c12ddaf0
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetLineChannel.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "LineChannel"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "generatedId": "id",
+ "channelSecret": null,
+ "channelAccessToken": null
+ }
+ ],
+ "callbackUrl": "http://callbackUrl",
+ "isValidated": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetOperations.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetOperations.json
new file mode 100644
index 000000000000..a8182d844186
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetOperations.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.BotService/botService/read",
+ "display": {
+ "provider": "Microsoft Bot Service",
+ "resource": "Bot Service",
+ "operation": "Read Bot Service",
+ "description": "Read Bot Service"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.BotService/botService/write",
+ "display": {
+ "provider": "Microsoft Bot Service",
+ "resource": "Bot Service",
+ "operation": "Write Bot Service",
+ "description": "Writes Bot Service"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.BotService/botService/delete",
+ "display": {
+ "provider": "Microsoft Bot Service",
+ "resource": "Bot Service",
+ "operation": "Delete Bot Service",
+ "description": "Deletes Bot Service"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.BotService/botService/botName/read",
+ "display": {
+ "provider": "Microsoft Bot Service",
+ "resource": "Bot Service name availability",
+ "operation": "Check bot name availability",
+ "description": "Check bot name availability"
+ },
+ "origin": "user,system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetPrivateEndpointConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..f04b0b4bb383
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/GetPrivateEndpointConnection.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "resourceName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.BotService/botServices/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.BotService/botServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsByResourceGroup.json
new file mode 100644
index 000000000000..f00d56e97ebf
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsByResourceGroup.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices",
+ "etag": "etag1",
+ "kind": "sdk",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsBySubscription.json
new file mode 100644
index 000000000000..69504e18e6a6
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListBotsBySubscription.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "kind": "sdk",
+ "etag": "etag1",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannel.json
new file mode 100644
index 000000000000..fe9b9a56da44
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannel.json
@@ -0,0 +1,79 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "resource": {
+ "properties": {
+ "sites": [
+ {
+ "siteId": "aaaaaaaaaaa",
+ "siteName": "aaaaaaaaaaaa",
+ "key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "key2": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "isEnabled": true,
+ "isV1Enabled": true,
+ "isV3Enabled": true,
+ "isSecureSiteEnabled": false,
+ "isBlockUserUploadEnabled": false,
+ "trustedOrigins": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ }
+ ]
+ },
+ "etag": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "channelName": "DirectLineChannel",
+ "location": "aaaaaa"
+ },
+ "setting": {
+ "extensionKey1": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionKey2": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "sites": [
+ {
+ "siteId": "aaaaaaaaaaa",
+ "siteName": "aaaaaaaaaaaa",
+ "key": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "key2": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "isEnabled": true,
+ "isV1Enabled": true,
+ "isV3Enabled": true,
+ "isWebchatPreviewEnabled": false,
+ "isSecureSiteEnabled": false,
+ "isBlockUserUploadEnabled": false,
+ "trustedOrigins": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ],
+ "isTokenEnabled": false,
+ "eTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "channelId": "aaaaaaaaaa",
+ "channelDisplayName": "aaaaaaaaaaa",
+ "botId": "aaaaaaaaaaaaaaaaaaaa",
+ "botIconUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "isEnabled": true,
+ "disableLocalAuth": false
+ },
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannelsByBotService.json
new file mode 100644
index 000000000000..9f186424c404
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListChannelsByBotService.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "resourceName": "samplebotname",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "FacebookChannel",
+ "properties": {
+ "appId": "id",
+ "callbackUrl": "appid",
+ "isEnabled": true,
+ "pages": [
+ {
+ "accessToken": null,
+ "id": "id"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListConnectionsByBotService.json
new file mode 100644
index 000000000000..31dff87f4479
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListConnectionsByBotService.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateEndpointConnections.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..153cf5f2233e
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateEndpointConnections.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "resourceName": "sto2527",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.BotService/botServices/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.BotService/botServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.BotService/botServices/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.BotService/botServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest02"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateLinkResources.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateLinkResources.json
new file mode 100644
index 000000000000..d6249663f985
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "resourceName": "sto2527",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.BotService/botServices/sto2527/privateLinkResources/resource1",
+ "name": "resource1",
+ "type": "Microsoft.BotService/botServices/privateLinkResources",
+ "properties": {
+ "groupId": "bot",
+ "requiredMembers": [
+ "bot"
+ ],
+ "requiredZoneNames": [
+ "privatelink.botframework.com"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListQnAMakerEndpointKeys.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListQnAMakerEndpointKeys.json
new file mode 100644
index 000000000000..c9cd1142dc0c
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListQnAMakerEndpointKeys.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "api-version": "2022-09-15",
+ "parameters": {
+ "hostname": "https://xxx.cognitiveservices.azure.com/",
+ "authkey": "testAuthKey"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "primaryEndpointKey": "sample_primaryEndpointKey",
+ "secondaryEndpointKey": "sample_secondaryEndpointKey",
+ "installedVersion": "4.1.0",
+ "lastStableVersion": "4.2.0"
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListServiceProviders.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListServiceProviders.json
new file mode 100644
index 000000000000..d43d37a0fa58
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/ListServiceProviders.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "api-version": "2022-09-15"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "id": "sampleServiceProviderId",
+ "displayName": "sample service provider display name",
+ "serviceProviderName": "sampleServiceProvider",
+ "devPortalUrl": "sampleDevPortalUrl",
+ "iconUrl": "sampleIconUrl",
+ "parameters": [
+ {
+ "name": "sampleParameterName",
+ "type": "sampleParameterType",
+ "displayName": "sampleDisplayName",
+ "description": "sampleDescription",
+ "helpUrl": "sampleHelpUrl",
+ "default": "sampleDefaultValue"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/OperationResultsGet.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/OperationResultsGet.json
new file mode 100644
index 000000000000..2f7ff73ca6cf
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/OperationResultsGet.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-09-15",
+ "subscriptionId": "subid",
+ "operationResultId": "exampleid"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/providers/Microsoft.BotService/locations/westus/operationresults/exampleid",
+ "name": "servicename",
+ "status": "Requested",
+ "startTime": "2019-01-21T06:03:30.2716301Z"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutAlexaChannel.json
new file mode 100644
index 000000000000..1036bbc7aa2e
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutAlexaChannel.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "AlexaChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "XAlexaSkillIdX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "alexa skill id",
+ "urlFragment": "XUrlFragmentX",
+ "serviceEndpointUri": "https://domain/XUrlFragmentX/botId",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "alexa skill id",
+ "urlFragment": "XUrlFragmentX",
+ "serviceEndpointUri": "https://domain/XUrlFragmentX/botId",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutChannel.json
new file mode 100644
index 000000000000..1c94583b0361
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutChannel.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutConnection.json
new file mode 100644
index 000000000000..f2b22b23f49c
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutConnection.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "connectionName": "sampleConnection",
+ "parameters": {
+ "location": "West US",
+ "etag": "etag1",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": "samplesecret",
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "global",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection",
+ "etag": "etag1",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "location": "global",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection",
+ "etag": "etag1",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutDirectLineSpeechChannel.json
new file mode 100644
index 000000000000..ceb5d24b67b5
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutDirectLineSpeechChannel.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "DirectLineSpeechChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "cognitiveServiceSubscriptionKey": "XcognitiveServiceSubscriptionKeyX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutEmailChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutEmailChannel.json
new file mode 100644
index 000000000000..303178e21dda
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutEmailChannel.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "magicCode": "000000",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "authMethod": 1,
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutLineChannel.json
new file mode 100644
index 000000000000..9d61be3c3d58
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutLineChannel.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "LineChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "channelSecret": "channelSecret",
+ "channelAccessToken": "channelAccessToken"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "generatedId": "id",
+ "channelSecret": null,
+ "channelAccessToken": null
+ }
+ ],
+ "callbackUrl": "http://callbackUrl",
+ "isValidated": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "generatedId": "id",
+ "channelSecret": null,
+ "channelAccessToken": null
+ }
+ ],
+ "callbackUrl": "http://callbackUrl",
+ "isValidated": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutPrivateEndpointConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutPrivateEndpointConnection.json
new file mode 100644
index 000000000000..c8209e549eda
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/PutPrivateEndpointConnection.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "resourceName": "sto9699",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-09-15",
+ "properties": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.BotService/botServices/sto288/privateEndpointConnections/{privateEndpointConnectionName}",
+ "name": "{privateEndpointConnectionName}",
+ "type": "Microsoft.BotService/botServices/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateAlexaChannel.json
new file mode 100644
index 000000000000..46f70ab87fab
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateAlexaChannel.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "AlexaChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "XAlexaSkillIdX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "XAlexaSkillIdX",
+ "urlFragment": "XUrlFragmentX",
+ "serviceEndpointUri": "https://domain/XUrlFragmentX/botId",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "AlexaChannel",
+ "properties": {
+ "alexaSkillId": "XAlexaSkillIdX",
+ "urlFragment": "XUrlFragmentX",
+ "serviceEndpointUri": "https://domain/XUrlFragmentX/botId",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateBot.json
new file mode 100644
index 000000000000..ebb7ffd06a70
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateBot.json
@@ -0,0 +1,131 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "parameters": {
+ "location": "West US",
+ "sku": {
+ "name": "S1"
+ },
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "etag": "etag1",
+ "kind": "sdk",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApiKey": "appinsightsapikey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "luisKey": "luiskey",
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "etag": "etag1",
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "kind": "sdk",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "location": "West US",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "name": "samplebotname",
+ "type": "Microsoft.BotService/botServices",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname",
+ "kind": "sdk",
+ "etag": "etag1",
+ "properties": {
+ "description": "The description of the bot",
+ "developerAppInsightKey": "appinsightskey",
+ "developerAppInsightsApplicationId": "appinsightsappid",
+ "displayName": "The Name of the bot",
+ "endpoint": "http://mybot.coffee",
+ "endpointVersion": "version",
+ "iconUrl": "http://myicon",
+ "luisAppIds": [
+ "luisappid1",
+ "luisappid2"
+ ],
+ "msaAppType": "UserAssignedMSI",
+ "msaAppId": "msaappid",
+ "msaAppTenantId": "msaapptenantid",
+ "msaAppMSIResourceId": "/subscriptions/foo/resourcegroups/bar/providers/microsoft.managedidentity/userassignedidentities/sampleId",
+ "configuredChannels": [
+ "facebook",
+ "groupme"
+ ],
+ "enabledChannels": [
+ "facebook"
+ ],
+ "isCmekEnabled": true,
+ "cmekKeyVaultUrl": "https://myCmekKey",
+ "publicNetworkAccess": "Enabled",
+ "disableLocalAuth": true,
+ "schemaTransformationVersion": "1.0"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateChannel.json
new file mode 100644
index 000000000000..1c94583b0361
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateChannel.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "EmailChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "EmailChannel",
+ "properties": {
+ "emailAddress": "a@b.com",
+ "password": "pwd",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateConnection.json
new file mode 100644
index 000000000000..f9ce026b165c
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateConnection.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "connectionName": "sampleConnection",
+ "parameters": {
+ "location": "global",
+ "etag": "etag1",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": "samplesecret",
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "global",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "location": "global",
+ "etag": "etag1",
+ "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection",
+ "name": "sampleConnection",
+ "properties": {
+ "clientId": "sampleclientid",
+ "clientSecret": null,
+ "scopes": "samplescope",
+ "serviceProviderId": "serviceproviderid",
+ "serviceProviderDisplayName": "serviceProviderDisplayName",
+ "parameters": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateDirectLineSpeechChannel.json
new file mode 100644
index 000000000000..ceb5d24b67b5
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateDirectLineSpeechChannel.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "DirectLineSpeechChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "cognitiveServiceSubscriptionKey": "XcognitiveServiceSubscriptionKeyX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "isEnabled": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "DirectLineSpeechChannel",
+ "properties": {
+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+ "isEnabled": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateLineChannel.json
new file mode 100644
index 000000000000..9d61be3c3d58
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/UpdateLineChannel.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "LineChannel",
+ "parameters": {
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "channelSecret": "channelSecret",
+ "channelAccessToken": "channelAccessToken"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "generatedId": "id",
+ "channelSecret": null,
+ "channelAccessToken": null
+ }
+ ],
+ "callbackUrl": "http://callbackUrl",
+ "isValidated": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices",
+ "location": "global",
+ "properties": {
+ "channelName": "LineChannel",
+ "properties": {
+ "lineRegistrations": [
+ {
+ "generatedId": "id",
+ "channelSecret": null,
+ "channelAccessToken": null
+ }
+ ],
+ "callbackUrl": "http://callbackUrl",
+ "isValidated": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/WebChatRegenerateKeys.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/WebChatRegenerateKeys.json
new file mode 100644
index 000000000000..e84b09d946b7
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/examples/WebChatRegenerateKeys.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "subscription-id",
+ "resourceGroupName": "OneResourceGroupName",
+ "api-version": "2022-09-15",
+ "resourceName": "samplebotname",
+ "channelName": "WebChatChannel",
+ "parameters": {
+ "siteName": "testSiteName",
+ "key": "key1"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "global",
+ "properties": {
+ "channelName": "WebChatChannel",
+ "properties": {
+ "sites": [
+ {
+ "siteId": "abcd",
+ "siteName": "Default Site",
+ "key": "key1",
+ "key2": "key2",
+ "isEnabled": true,
+ "isWebchatPreviewEnabled": true
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/privatelinks.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/privatelinks.json
new file mode 100644
index 000000000000..a0250342682d
--- /dev/null
+++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/privatelinks.json
@@ -0,0 +1,203 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-09-15",
+ "title": "Common types"
+ },
+ "paths": {},
+ "definitions": {
+ "PrivateEndpoint": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ARM identifier for Private Endpoint"
+ }
+ },
+ "description": "The Private Endpoint resource."
+ },
+ "PrivateLinkResourceBase": {
+ "title": "Private Link Resource Base",
+ "description": "Common fields that are returned in the response for all BotService Private Link Resources",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "PrivateEndpointConnection": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "x-ms-client-flatten": true,
+ "description": "Resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/PrivateLinkResourceBase"
+ }
+ ],
+ "description": "The Private Endpoint Connection resource."
+ },
+ "PrivateEndpointConnectionProperties": {
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private end point."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
+ "description": "The provisioning state of the private endpoint connection resource."
+ },
+ "groupIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Group ids"
+ }
+ },
+ "required": [
+ "privateLinkServiceConnectionState"
+ ],
+ "description": "Properties of the PrivateEndpointConnectProperties."
+ },
+ "PrivateLinkServiceConnectionState": {
+ "properties": {
+ "status": {
+ "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus",
+ "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
+ },
+ "description": {
+ "type": "string",
+ "description": "The reason for approval/rejection of the connection."
+ },
+ "actionsRequired": {
+ "type": "string",
+ "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ }
+ },
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "PrivateEndpointServiceConnectionStatus": {
+ "type": "string",
+ "description": "The private endpoint connection status.",
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointServiceConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "PrivateEndpointConnectionProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Creating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "PrivateLinkResource": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Resource properties.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/PrivateLinkResourceBase"
+ }
+ ],
+ "description": "A private link resource"
+ },
+ "PrivateLinkResourceProperties": {
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requiredMembers": {
+ "description": "The private link resource required member names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "requiredZoneNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The private link resource Private link DNS zone name."
+ }
+ },
+ "description": "Properties of a private link resource."
+ },
+ "PrivateEndpointConnectionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private endpoint connections",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ },
+ "description": "List of private endpoint connection associated with the specified storage account"
+ },
+ "PrivateLinkResourceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Array of private link resources",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ },
+ "description": "A list of private link resources"
+ }
+ },
+ "parameters": {
+ "PrivateEndpointConnectionName": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection associated with the Azure resource",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md
index 765e84d2f642..02083594aa83 100644
--- a/specification/botservice/resource-manager/readme.md
+++ b/specification/botservice/resource-manager/readme.md
@@ -26,15 +26,36 @@ These are the global settings for the BotService API.
``` yaml
openapi-type: arm
-tag: package-preview-2022-06
+tag: package-2022-09
```
+### Tag: package-2022-09
+
+These settings apply only when `--tag=package-2022-09` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-09'
+input-file:
+ - Microsoft.BotService/stable/2022-09-15/botservice.json
+directive:
+ - suppress: R4009
+ from: botservice.json
+ reason: We don not yet support systemdata
+ - suppress: R4018
+ from: botservice.json
+ reason: We don not yet support systemdata
+ - suppress: R3016
+ from: botservice.json
+ reason: app settings keys are case sensitive
+ - suppress: R3018
+ from: botservice.json
+ reason: app settings for ValidateAuthority needs to be boolean
+```
### Tag: package-preview-2022-06
These settings apply only when `--tag=package-preview-2022-06` is specified on the command line.
-```yaml $(tag) == 'package-preview-2022-06'
+``` yaml $(tag) == 'package-preview-2022-06'
input-file:
- Microsoft.BotService/preview/2022-06-15-preview/botservice.json
directive:
@@ -51,6 +72,7 @@ directive:
from: botservice.json
reason: app settings for ValidateAuthority needs to be boolean
```
+
### Tag: package-preview-2021-05
These settings apply only when `--tag=package-preview-2021-05` is specified on the command line.
diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2022-10-01-preview/types/experiments.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2022-10-01-preview/types/experiments.json
index 0db5ecc7df22..f279536f95ba 100644
--- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2022-10-01-preview/types/experiments.json
+++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2022-10-01-preview/types/experiments.json
@@ -212,7 +212,8 @@
"duration": {
"type": "string",
"description": "ISO8601 formatted string that represents a duration.",
- "pattern": "^P(\\d+Y)?(\\d+M)?(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(\\.\\d+)?S)?)?$"
+ "pattern": "^P(\\d+Y)?(\\d+M)?(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(\\.\\d+)?S)?)?$",
+ "format": "duration"
}
},
"required": [
@@ -265,7 +266,8 @@
"duration": {
"type": "string",
"description": "ISO8601 formatted string that represents a duration.",
- "pattern": "^P(\\d+Y)?(\\d+M)?(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(\\.\\d+)?S)?)?$"
+ "pattern": "^P(\\d+Y)?(\\d+M)?(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(\\.\\d+)?S)?)?$",
+ "format": "duration"
},
"parameters": {
"description": "List of key value pairs.",
diff --git a/specification/cognitiveservices/AnomalyDetector/cadl-project.yaml b/specification/cognitiveservices/AnomalyDetector/cadl-project.yaml
index fd8241c478d1..851b6772666d 100644
--- a/specification/cognitiveservices/AnomalyDetector/cadl-project.yaml
+++ b/specification/cognitiveservices/AnomalyDetector/cadl-project.yaml
@@ -1,4 +1,9 @@
-emitters:
+emit: [
+ "@azure-tools/cadl-autorest",
+ "@azure-tools/cadl-python",
+ "@azure-tools/cadl-csharp",
+]
+options:
"@azure-tools/cadl-autorest":
"output-file": "openapi.json"
"examples-directory": ./examples
diff --git a/specification/cognitiveservices/AnomalyDetector/main.cadl b/specification/cognitiveservices/AnomalyDetector/main.cadl
index 2cc97c6d4947..3c1b0d91954b 100644
--- a/specification/cognitiveservices/AnomalyDetector/main.cadl
+++ b/specification/cognitiveservices/AnomalyDetector/main.cadl
@@ -7,7 +7,7 @@ using Cadl.Rest;
using Cadl.Http;
using Cadl.Versioning;
-@versioned(Versions)
+@versioned(APIVersion)
@service({title: "Anomaly Detector"})
@useAuth(ApiKeyAuth)
@server(
@@ -45,9 +45,6 @@ discover incidents and establish a logic flow for root cause analysis.
""")
namespace AnomalyDetector;
-enum Versions {
+enum APIVersion {
v1_1: "v1.1",
}
-
-@knownValues(Versions)
-model APIVersion is string;
diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/models.cadl b/specification/cognitiveservices/AnomalyDetector/multivariate/models.cadl
index e04f71124e1e..0af8d1ade04b 100644
--- a/specification/cognitiveservices/AnomalyDetector/multivariate/models.cadl
+++ b/specification/cognitiveservices/AnomalyDetector/multivariate/models.cadl
@@ -7,7 +7,8 @@ using Azure.Core;
namespace AnomalyDetector.Multivariate;
-enum FillNAMethodKnownValues {
+@doc("An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed.")
+enum FillNAMethod {
"Previous",
"Subsequent",
"Linear",
@@ -15,10 +16,7 @@ enum FillNAMethodKnownValues {
"Fixed",
}
-@doc("An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed.")
-@knownValues(FillNAMethodKnownValues)
-model FillNAMethod is string;
-
+@fixed
enum MultivariateBatchDetectionStatus {
Created: "CREATED",
Running: "RUNNING",
@@ -26,22 +24,21 @@ enum MultivariateBatchDetectionStatus {
Failed: "FAILED",
}
-enum DataSchemaValues {
+@doc("Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable.")
+enum DataSchema {
@doc("OneTable means that your input data are all in one CSV file, which contains one 'timestamp' column and several variable columns. The default DataSchema is OneTable.")
"OneTable",
@doc("MultiTable means that your input data are separated in multiple CSV files, in each file containing one 'timestamp' column and one 'variable' column, and the CSV file name should indicate the name of the variable. The default DataSchema is OneTable.")
"MultiTable",
}
-@doc("Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable.")
-@knownValues(DataSchemaValues)
-model DataSchema is string;
-
+@fixed
enum AlignMode {
"Inner",
"Outer",
}
+@fixed
enum ModelStatus {
Created: "CREATED",
Running: "RUNNING",
@@ -53,6 +50,7 @@ enum ModelStatus {
@resource("multivariate/detect-batch")
model MultivariateDetectionResult {
@doc("Result identifier, which is used to fetch the results of an inference call.")
+ @visibility("read")
@key
@format("uuid")
resultId: string;
@@ -311,6 +309,7 @@ epoch.
@resource("multivariate/models")
model AnomalyDetectionModel {
@doc("Model identifier.")
+ @visibility("read")
@key
@format("uuid")
modelId: string;
diff --git a/specification/cognitiveservices/AnomalyDetector/package.json b/specification/cognitiveservices/AnomalyDetector/package.json
index 16bef67f29a2..3a54ffe051bb 100644
--- a/specification/cognitiveservices/AnomalyDetector/package.json
+++ b/specification/cognitiveservices/AnomalyDetector/package.json
@@ -10,8 +10,10 @@
"@azure-tools/cadl-dpg": "latest",
"@azure-tools/cadl-python": "latest",
"@cadl-lang/compiler": "latest",
+ "@cadl-lang/openapi": "latest",
"@cadl-lang/openapi3": "latest",
"@cadl-lang/prettier-plugin-cadl": "latest",
+ "@cadl-lang/rest": "latest",
"prettier": "latest"
},
"private": true
diff --git a/specification/cognitiveservices/AnomalyDetector/univariate/models.cadl b/specification/cognitiveservices/AnomalyDetector/univariate/models.cadl
index ead1c5f87f81..bfc127e25b10 100644
--- a/specification/cognitiveservices/AnomalyDetector/univariate/models.cadl
+++ b/specification/cognitiveservices/AnomalyDetector/univariate/models.cadl
@@ -7,7 +7,7 @@ using Azure.Core;
namespace AnomalyDetector.Univariate;
-enum ImputeModeKnownValues {
+enum ImputeMode {
Auto: "auto",
Previous: "previous",
Linear: "linear",
@@ -16,10 +16,7 @@ enum ImputeModeKnownValues {
NotFill: "notFill",
}
-@knownValues(ImputeModeKnownValues)
-model ImputeMode is string;
-
-enum AnomalyDetectorErrorCodesKnownValues {
+enum AnomalyDetectorErrorCodes {
"InvalidCustomInterval",
"BadArgument",
"InvalidGranularity",
@@ -33,9 +30,7 @@ enum AnomalyDetectorErrorCodesKnownValues {
"InvalidImputeFixedValue",
}
-@knownValues(AnomalyDetectorErrorCodesKnownValues)
-model AnomalyDetectorErrorCodes is string;
-
+@fixed
enum TimeGranularity {
Yearly: "yearly",
Monthly: "monthly",
diff --git a/specification/cognitiveservices/OpenAI.Authoring/README.md b/specification/cognitiveservices/OpenAI.Authoring/README.md
new file mode 100644
index 000000000000..119b6a6a9d9d
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/README.md
@@ -0,0 +1,5 @@
+title: AzureOpenAI
+clear-output-folder: false
+guessResourceKey: true
+isAzureSpec: true
+namespace: azure.openai.authoring
\ No newline at end of file
diff --git a/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json
new file mode 100644
index 000000000000..d619df664803
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json
@@ -0,0 +1,2019 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure OpenAI API",
+ "version": "2022-06-01-preview",
+ "description": "API for managing and utilizing Azure Open AI endpoints",
+ "x-cadl-generated": [
+ {
+ "emitter": "@azure-tools/cadl-autorest"
+ }
+ ]
+ },
+ "schemes": [
+ "https"
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{endpoint}/openai",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "name": "endpoint",
+ "in": "path",
+ "required": true,
+ "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus.api.cognitive.microsoft.com).",
+ "type": "string"
+ }
+ ]
+ },
+ "produces": [
+ "application/json"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "OAuth2Auth": []
+ }
+ ],
+ "securityDefinitions": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "apiKey"
+ },
+ "OAuth2Auth": {
+ "type": "oauth2",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+ "scopes": {}
+ }
+ },
+ "tags": [],
+ "paths": {
+ "/deployments": {
+ "get": {
+ "operationId": "Deployments_ListDeployments",
+ "summary": "Gets the list of deployments owned by the Azure OpenAI resource.",
+ "description": "Gets the list of deployments owned by the Azure OpenAI resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "Deployments_CreateDeployment",
+ "summary": "Creates a new deployment for the Azure OpenAI resource according to the given\nspecification.",
+ "description": "Creates a new deployment for the Azure OpenAI resource according to the given\nspecification.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "The template for adding updateable properties.",
+ "required": [
+ "model",
+ "scale_settings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrReplaceModel"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "Location": {
+ "description": "The location of an instance of Deployment",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "required": [
+ "status",
+ "created_at",
+ "updated_at",
+ "id",
+ "model",
+ "scale_settings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.CustomResponseFields<(anonymous model)>"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/deployments/{deploymentId}": {
+ "get": {
+ "operationId": "Deployments_GetDeployment",
+ "summary": "Gets details for a single deployment specified by the given deployment_id.",
+ "description": "Gets details for a single deployment specified by the given deployment_id.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "operationId": "Deployments_UpdateDeployment",
+ "summary": "Updates the mutable details of the deployment with the given deployment_id.",
+ "description": "Updates the mutable details of the deployment with the given deployment_id.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "The template for adding optional properties.",
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrUpdateModel"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "required": [
+ "status",
+ "created_at",
+ "updated_at",
+ "id",
+ "model",
+ "scale_settings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceOkResponse"
+ }
+ },
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "A resource was successfully created.",
+ "required": [
+ "status",
+ "created_at",
+ "updated_at",
+ "id",
+ "model",
+ "scale_settings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreatedResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ },
+ "consumes": [
+ "application/merge-patch+json"
+ ]
+ },
+ "delete": {
+ "operationId": "Deployments_DeleteDeployment",
+ "summary": "Deletes the deployment specified by the given deployment_id.",
+ "description": "Deletes the deployment specified by the given deployment_id.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/files": {
+ "get": {
+ "operationId": "Files_ListFiles",
+ "summary": "Gets a list of all files owned by the Azure OpenAI resource.\nThese include user uploaded content like files with purpose \"fine-tune\" for training or\nvalidation of fine-tunes models as well as files that are generated by the\nservice such as \"fine-tune-results\" which contains various metrics for the\ncorresponding fine-tune job.",
+ "description": "Gets a list of all files owned by the Azure OpenAI resource.\nThese include user uploaded content like files with purpose \"fine-tune\" for training or\nvalidation of fine-tunes models\nas well as files that are generated by the\nservice such as \"fine-tune-results\" which contains various metrics for the\ncorresponding fine-tune job.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FileList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "Files_UploadFile",
+ "summary": "Creates a new file entity by uploading data from a local machine. Uploaded\nfiles can, for example, be used for training or evaluating fine-tuned models.",
+ "description": "Creates a new file entity by uploading data from a local machine. Uploaded\nfiles can, for example, be used for training or evaluating fine-tuned models.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "description": "The template for adding updateable properties.",
+ "required": [
+ "purpose",
+ "filename"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrReplaceModel"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "Location": {
+ "description": "The location of an instance of File",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "bytes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of this file when available (can be null). File sizes larger than\n2^53-1 are not supported to ensure compatibility\nwith JavaScript integers.",
+ "readOnly": true
+ },
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "required": [
+ "id",
+ "purpose",
+ "filename"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.CustomResponseFields<(anonymous model)>"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/files/{fileId}": {
+ "get": {
+ "operationId": "Files_GetFile",
+ "summary": "Gets details for a single file specified by the given file_id including status,\nsize, purpose, etc.",
+ "description": "Gets details for a single file specified by the given file_id including status,\nsize, purpose, etc.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/File"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "Files_DeleteFile",
+ "summary": "Deletes the file with the given file_id.\nDeletion is also allowed if a file\nwas used, e.g., as training file in a fine-tune job.",
+ "description": "Deletes the file with the given file_id.\nDeletion is also allowed if a file\nwas used, e.g., as training file in a fine-tune job.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/files/{fileId}/content": {
+ "get": {
+ "operationId": "Files_GetFileContent",
+ "summary": "Gets the content of the file specified by the given file_id.\nFiles can be user\nuploaded content or generated by the service like result metrics of a fine-tune\njob.",
+ "description": "Gets the content of the file specified by the given file_id.\nFiles can be user\nuploaded content or generated by the service like result metrics of a fine-tune\njob.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FileContent"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/files/import": {
+ "post": {
+ "operationId": "Files_ImportFile",
+ "summary": "Creates a new file entity by importing data from a provided url. Uploaded files\ncan, for example, be used for training or evaluating fine-tuned models.",
+ "description": "Creates a new file entity by importing data from a provided url. Uploaded files\ncan, for example, be used for training or evaluating fine-tuned models.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "required": true,
+ "description": "expected schema for the body of the completion post request",
+ "schema": {
+ "$ref": "#/definitions/FileImport"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "location": {
+ "description": "Location of the newly created item",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/File"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes": {
+ "get": {
+ "operationId": "FineTunes_ListFineTunes",
+ "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\nThe details that are returned for each fine-tune job contain besides its\nidentifier the base model, training and validation files, hyper parameters,\ntime stamps, status and events. Events are created when the job status\nchanges, e.g. running or complete, and when results are uploaded.",
+ "description": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\nThe details that are returned for each fine-tune job contain besides its\nidentifier the base model, training and validation files, hyper parameters,\ntime stamps, status and events. Events are created when the job status\nchanges, e.g. running or complete, and when results are uploaded.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTuneList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "FineTunes_CreateFineTune",
+ "summary": "Creates a job that fine-tunes a specified model from a given training\nfile.\nResponse includes details of the enqueued job including job status and\nhyper parameters.\nThe name of the fine-tuned model is added to the response\nonce complete.",
+ "description": "Creates a job that fine-tunes a specified model from a given training\nfile.\nResponse includes details of the enqueued job including job status and\nhyper parameters.\nThe name of the fine-tuned model is added to the response\nonce complete.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/FineTuneCreation"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "location": {
+ "description": "Location of the newly created item",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}": {
+ "get": {
+ "operationId": "FineTunes_GetFineTune",
+ "summary": "Gets details for a single fine-tune job specified by the given\nfine_tune_id.\nThe details contain the base model, training and validation\nfiles, hyper parameters, time stamps, status and events.\nEvents are created\nwhen the job status changes, e.g. running or complete, and when results are\nuploaded.",
+ "description": "Gets details for a single fine-tune job specified by the given\nfine_tune_id.\nThe details contain the base model, training and validation\nfiles, hyper parameters, time stamps, status and events.\nEvents are created\nwhen the job status changes, e.g. running or complete, and when results are\nuploaded.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "FineTunes_DeleteFineTune",
+ "summary": "Deletes the fine-tune job specified by the given fine_tune_id.",
+ "description": "Deletes the fine-tune job specified by the given fine_tune_id.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}/cancel": {
+ "post": {
+ "operationId": "FineTunes_CancelFineTune",
+ "summary": "Cancels the processing of the fine-tune job specified by the given fine_tune_id.",
+ "description": "Cancels the processing of the fine-tune job specified by the given fine_tune_id.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}/listFineTuneEvents": {
+ "get": {
+ "operationId": "FineTunes_ListFineTuneEvents",
+ "summary": "List events for the fine-tune job specified by the given fine_tune_id.\nEvents are created when the job status changes, e.g. running or\ncomplete, and when results are uploaded.",
+ "description": "List events for the fine-tune job specified by the given fine_tune_id.\nEvents are created when the job status changes, e.g. running or\ncomplete, and when results are uploaded.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "name": "stream",
+ "in": "query",
+ "required": true,
+ "description": "A flag indicating whether to stream events for the fine-tune job. If set to true,\nevents will be sent as data-only server-sent events as they become available. The stream will terminate with\na data: [DONE] message when the job is finished (succeeded, cancelled, or failed).\nIf set to false, only events generated so far will be returned..",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/EventList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models": {
+ "get": {
+ "operationId": "Models_ListModels",
+ "summary": "Gets a list of all models that are accessible by the Azure OpenAI\nresource.\nThese include base models as well as all successfully completed\nfine-tuned models owned by the Azure OpenAI resource.",
+ "description": "Gets a list of all models that are accessible by the Azure OpenAI\nresource.\nThese include base models as well as all successfully completed\nfine-tuned models owned by the Azure OpenAI resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ModelList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models/{model_id}": {
+ "get": {
+ "operationId": "Models_GetModel",
+ "summary": "Gets details for the model specified by the given model_id.",
+ "description": "Gets details for the model specified by the given model_id.",
+ "parameters": [
+ {
+ "name": "model_id",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Model"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Azure.Core.Foundations.Error": {
+ "type": "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",
+ "items": {
+ "$ref": "#/definitions/Azure.Core.Foundations.Error"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Azure.Core.Foundations.Error[]",
+ "description": "An array of details about specific errors that led to this reported error."
+ },
+ "innererror": {
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
+ "description": "An object containing more specific information than the current object about the error."
+ }
+ },
+ "description": "The error object.",
+ "required": [
+ "code",
+ "message",
+ "details"
+ ]
+ },
+ "Azure.Core.Foundations.ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Azure.Core.Foundations.Error",
+ "description": "The error object."
+ }
+ },
+ "description": "A response containing error details.",
+ "required": [
+ "error"
+ ]
+ },
+ "Azure.Core.Foundations.InnerError": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "One of a server-defined set of error codes."
+ },
+ "innererror": {
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
+ "description": "Inner error."
+ }
+ },
+ "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.",
+ "required": [
+ "code"
+ ]
+ },
+ "Capabilities": {
+ "type": "object",
+ "properties": {
+ "fine_tune": {
+ "type": "boolean",
+ "description": "A value indicating whether a model can be used for fine tuning.",
+ "readOnly": true
+ },
+ "inference": {
+ "type": "boolean",
+ "description": "A value indicating whether a model can be deployed.",
+ "readOnly": true
+ },
+ "completion": {
+ "type": "boolean",
+ "description": "A value indicating whether a model supports completion.",
+ "readOnly": true
+ },
+ "embeddings": {
+ "type": "boolean",
+ "description": "A value indicating whether a model supports embeddings.",
+ "readOnly": true
+ },
+ "scale_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScaleType"
+ },
+ "x-cadl-name": "ScaleType[]",
+ "description": "The supported scale types for deployments of this model.",
+ "readOnly": true
+ }
+ },
+ "description": "The capabilities of a base or fine tune model."
+ },
+ "CreatedResponse": {
+ "type": "object",
+ "properties": {},
+ "description": "Created Response"
+ },
+ "Deployment": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scale_settings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "Deployments manage the reserved quota for Azure OpenAI models and make them\navailable for inference requests.",
+ "required": [
+ "status",
+ "created_at",
+ "updated_at",
+ "id",
+ "model",
+ "scale_settings"
+ ]
+ },
+ "DeploymentList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "type": "string",
+ "enum": [
+ "deployment"
+ ],
+ "x-ms-enum": {
+ "modelAsString": false
+ },
+ "description": "Defines the type of this object"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "x-cadl-name": "Deployment[]",
+ "description": "The list of Deployments"
+ }
+ }
+ },
+ "Deprecation": {
+ "type": "object",
+ "properties": {
+ "fine_tune_end_date": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The end date of fine tune support of this model. Will be `null` for fine tune\nmodels.",
+ "readOnly": true
+ },
+ "inference": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The end date of inference support of this model.",
+ "readOnly": true
+ }
+ },
+ "description": "Defines the dates of deprecation for the different use cases of a\nmodel.\nUsually base models support 1 year of fine tuning after creation.\nInference is typically supported 2 years after creation of base or\nfine tuned\nmodels. The exact dates are specified in the properties."
+ },
+ "ErrorCode": {
+ "type": "string",
+ "enum": [
+ "conflict",
+ "invalidPayload",
+ "forbidden",
+ "notFound",
+ "unexpectedEntityState",
+ "itemDoesAlreadyExist",
+ "serviceUnavailable",
+ "internalFailure",
+ "quotaExceeded"
+ ],
+ "x-ms-enum": {
+ "name": "ErrorCode",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Conflict",
+ "value": "conflict"
+ },
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ },
+ {
+ "name": "Forbidden",
+ "value": "forbidden"
+ },
+ {
+ "name": "NotFound",
+ "value": "notFound"
+ },
+ {
+ "name": "UnexpectedEntityState",
+ "value": "unexpectedEntityState"
+ },
+ {
+ "name": "ItemDoesAlreadyExist",
+ "value": "itemDoesAlreadyExist"
+ },
+ {
+ "name": "ServiceUnavailable",
+ "value": "serviceUnavailable"
+ },
+ {
+ "name": "InternalFailure",
+ "value": "internalFailure"
+ },
+ {
+ "name": "QuotaExceeded",
+ "value": "quotaExceeded"
+ }
+ ]
+ }
+ },
+ "ErrorCodeKnownValues": {
+ "type": "string",
+ "enum": [
+ "conflict",
+ "invalidPayload",
+ "forbidden",
+ "notFound",
+ "unexpectedEntityState",
+ "itemDoesAlreadyExist",
+ "serviceUnavailable",
+ "internalFailure",
+ "quotaExceeded"
+ ],
+ "x-ms-enum": {
+ "name": "ErrorCodeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Conflict",
+ "value": "conflict"
+ },
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ },
+ {
+ "name": "Forbidden",
+ "value": "forbidden"
+ },
+ {
+ "name": "NotFound",
+ "value": "notFound"
+ },
+ {
+ "name": "UnexpectedEntityState",
+ "value": "unexpectedEntityState"
+ },
+ {
+ "name": "ItemDoesAlreadyExist",
+ "value": "itemDoesAlreadyExist"
+ },
+ {
+ "name": "ServiceUnavailable",
+ "value": "serviceUnavailable"
+ },
+ {
+ "name": "InternalFailure",
+ "value": "internalFailure"
+ },
+ {
+ "name": "QuotaExceeded",
+ "value": "quotaExceeded"
+ }
+ ]
+ }
+ },
+ "Event": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this event was created (in unix epochs).",
+ "readOnly": true
+ },
+ "level": {
+ "$ref": "#/definitions/LogLevel",
+ "description": "The verbosity level of an event.",
+ "readOnly": true
+ },
+ "message": {
+ "type": "string",
+ "description": "The message describing the event. This can be a change of state, e.g.,\nenqueued, started, failed or completed, or other events like uploaded results.",
+ "readOnly": true
+ }
+ },
+ "description": "Event"
+ },
+ "EventList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of this object"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Event[]",
+ "description": "The list of Events"
+ }
+ }
+ },
+ "File": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "bytes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of this file when available (can be null). File sizes larger than\n2^53-1 are not supported to ensure compatibility\nwith JavaScript integers.",
+ "readOnly": true
+ },
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "description": "A file is a document usable for training and validation. It can also be a\nservice generated document with result details.",
+ "required": [
+ "id",
+ "purpose",
+ "filename"
+ ]
+ },
+ "FileContent": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "file": {
+ "type": "string",
+ "format": "byte",
+ "description": "Gets or sets the file to upload into Azure OpenAI."
+ }
+ },
+ "description": "content of uploaded file",
+ "required": [
+ "purpose",
+ "file"
+ ]
+ },
+ "FileImport": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file\nto be uploaded.\nIf the `purpose` is set to \"fine-tune\", each line is a JSON\nrecord with \"prompt\" and \"completion\" fields representing your training\nexamples."
+ },
+ "content_url": {
+ "type": "string",
+ "description": "The url to download the document from (can be SAS url of a blob or any other\nexternal url accessible with a GET request)."
+ }
+ },
+ "description": "Defines a document to import from an external content url to be usable with\nAzure OpenAI.",
+ "required": [
+ "purpose",
+ "filename",
+ "content_url"
+ ]
+ },
+ "FileList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "type": "string",
+ "enum": [
+ "file"
+ ],
+ "x-ms-enum": {
+ "modelAsString": false
+ },
+ "description": "Defines the type of this object"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The list of Files"
+ }
+ }
+ },
+ "FineTune": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The identifier of the base model used for the fine-tune."
+ },
+ "fine_tuned_model": {
+ "type": "string",
+ "description": "The identifier of the resulting fine tuned model. This property is only\npopulated for successfully completed fine-tune runs.\nUse this identifier to\ncreate a deployment for inferencing.",
+ "readOnly": true
+ },
+ "training_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The files that are used for training the fine tuned model."
+ },
+ "validation_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The files that are used to evaluate the fine tuned model during training."
+ },
+ "result_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The result files containing training and evaluation metrics in csv format.\nThe\nfile is only available for successfully completed fine-tune runs.",
+ "readOnly": true
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Event[]",
+ "description": "The events that show the progress of the fine-tune run including queued,\nrunning and completed.",
+ "readOnly": true
+ },
+ "organisation_id": {
+ "type": "string",
+ "description": "The organisation id of this fine tune job. Unused on Azure OpenAI;\ncompatibility for OpenAI only.",
+ "readOnly": true
+ },
+ "user_id": {
+ "type": "string",
+ "description": "The user id of this fine tune job. Unused on Azure OpenAI; compatibility for\nOpenAI only.",
+ "readOnly": true
+ },
+ "hyperparams": {
+ "$ref": "#/definitions/HyperParameters",
+ "description": "The hyper parameter settings used in a fine tune job."
+ }
+ },
+ "description": "Fine tuning is a job to tailor a model to specific training data.",
+ "required": [
+ "id",
+ "model",
+ "training_files"
+ ]
+ },
+ "FineTuneCreation": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The identifier of the base model used for this fine-tune."
+ },
+ "training_file": {
+ "type": "string",
+ "description": "The file that is used for training this fine tuned model."
+ },
+ "validation_file": {
+ "type": "string",
+ "description": "The file that is used to evaluate the fine tuned model during training."
+ },
+ "hyperparams": {
+ "$ref": "#/definitions/HyperParameters",
+ "description": "The hyper parameter settings used in a fine tune job."
+ }
+ },
+ "description": "Defines the values of a fine tune job.",
+ "required": [
+ "model",
+ "training_file"
+ ]
+ },
+ "FineTuneList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "type": "string",
+ "enum": [
+ "fine-tune"
+ ],
+ "x-ms-enum": {
+ "modelAsString": false
+ },
+ "description": "Defines the type of this object"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FineTune"
+ },
+ "x-cadl-name": "FineTune[]",
+ "description": "The list of FineTunes"
+ }
+ }
+ },
+ "HyperParameters": {
+ "type": "object",
+ "properties": {
+ "batch_size": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The batch size to use for training. The batch size is the number of training\nexamples used to train a single forward and backward pass.\nIn general, we've\nfound that larger batch sizes tend to work better for larger datasets.\nThe\ndefault value as well as the maximum value for this property are specific to a\nbase model."
+ },
+ "learning_rate_multiplier": {
+ "type": "number",
+ "format": "float",
+ "description": "The learning rate multiplier to use for training. The fine-tuning learning rate\nis the original learning rate used for pre-training multiplied by this\nvalue.\nLarger learning rates tend to perform better with larger batch\nsizes.\nWe recommend experimenting with values in the range 0.02 to 0.2 to see\nwhat produces the best results."
+ },
+ "n_epochs": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset."
+ },
+ "prompt_loss_weight": {
+ "type": "number",
+ "format": "float",
+ "description": "The weight to use for loss on the prompt tokens. This controls how much the\nmodel tries to learn to generate the prompt\n(as compared to the completion\nwhich always has a weight of 1.0), and can add a stabilizing effect to training\nwhen completions are short.\nIf prompts are extremely long (relative to\ncompletions), it may make sense to reduce this weight so as to avoid\nover-prioritizing learning the prompt."
+ },
+ "compute_classification_metrics": {
+ "type": "boolean",
+ "description": "A value indicating whether to compute classification metrics.\nIf set, we\ncalculate classification-specific metrics such as accuracy and F-1 score using\nthe validation set at the end of every epoch.\nThese metrics can be viewed in\nthe results file. In order to compute classification metrics, you must provide\na validation_file.Additionally,\nyou must specify classification_n_classes for\nmulticlass classification or classification_positive_class for binary\nclassification."
+ },
+ "classification_n_classes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of classes in a classification task.\nThis parameter is required for\nmulticlass classification."
+ },
+ "classification_positive_class": {
+ "type": "string",
+ "description": "The positive class in binary classification.\nThis parameter is needed to\ngenerate precision, recall, and F1 metrics when doing binary classification."
+ },
+ "classification_betas": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "float"
+ },
+ "x-cadl-name": "float32[]",
+ "description": "The classification beta values. If this is provided, we calculate F-beta scores\nat the specified beta values.\nThe F-beta score is a generalization of F-1\nscore. This is only used for binary classification.\nWith a beta of 1 (i.e.the\nF-1 score), precision and recall are given the same weight.\nA larger beta\nscore puts more weight on recall and less on precision. A smaller beta score\nputs more weight on precision and less on recall."
+ }
+ },
+ "description": "The hyper parameter settings used in a fine tune job."
+ },
+ "InnerErrorCode": {
+ "type": "string",
+ "enum": [
+ "invalidPayload"
+ ],
+ "x-ms-enum": {
+ "name": "InnerErrorCode",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ }
+ ]
+ }
+ },
+ "InnerErrorCodeKnownValues": {
+ "type": "string",
+ "enum": [
+ "invalidPayload"
+ ],
+ "x-ms-enum": {
+ "name": "InnerErrorCodeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ }
+ ]
+ }
+ },
+ "LogLevel": {
+ "type": "string",
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Info",
+ "value": "info"
+ },
+ {
+ "name": "Warning",
+ "value": "warning"
+ },
+ {
+ "name": "Error",
+ "value": "error"
+ }
+ ]
+ }
+ },
+ "ManualScaleSettings": {
+ "type": "object",
+ "properties": {
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The constant reserved capacity of the inference endpoint for this deployment."
+ }
+ },
+ "description": "Settings for the manual scale type.",
+ "required": [
+ "capacity"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScaleSettings"
+ }
+ ],
+ "x-ms-discriminator-value": "manual"
+ },
+ "Model": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The base model ID if this is a fine tune model; otherwise `null`.",
+ "readOnly": true
+ },
+ "fine_tune": {
+ "type": "string",
+ "description": "The fine tune job ID if this is a fine tune model; otherwise `null`.",
+ "readOnly": true
+ },
+ "capabilities": {
+ "$ref": "#/definitions/Capabilities",
+ "description": "The capabilities of a base or fine tune model."
+ },
+ "deprecation": {
+ "$ref": "#/definitions/Deprecation",
+ "description": "Defines the dates of deprecation for the different use cases of a\nmodel.\nUsually base models support 1 year of fine tuning after creation.\nInference is typically supported 2 years after creation of base or\nfine tuned\nmodels. The exact dates are specified in the properties."
+ }
+ },
+ "description": "A model is either a base model or the result of a successful fine tune job.",
+ "required": [
+ "id"
+ ]
+ },
+ "ModelList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "type": "string",
+ "enum": [
+ "model"
+ ],
+ "x-ms-enum": {
+ "modelAsString": false
+ },
+ "description": "Defines the type of this object"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Model"
+ },
+ "x-cadl-name": "Model[]",
+ "description": "The list of Models"
+ }
+ }
+ },
+ "Purpose": {
+ "type": "string",
+ "enum": [
+ "fine-tune",
+ "fine-tune-results"
+ ],
+ "x-ms-enum": {
+ "name": "Purpose",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "FineTuneResults",
+ "value": "fine-tune-results"
+ }
+ ]
+ }
+ },
+ "PurposeKnownValues": {
+ "type": "string",
+ "enum": [
+ "fine-tune",
+ "fine-tune-results"
+ ],
+ "x-ms-enum": {
+ "name": "PurposeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "FineTuneResults",
+ "value": "fine-tune-results"
+ }
+ ]
+ }
+ },
+ "ScaleSettings": {
+ "type": "object",
+ "properties": {
+ "scale_type": {
+ "type": "string",
+ "description": "Discriminator property for ScaleSettings."
+ }
+ },
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity.",
+ "discriminator": "scale_type",
+ "required": [
+ "scale_type"
+ ]
+ },
+ "ScaleType": {
+ "type": "string",
+ "enum": [
+ "manual",
+ "standard"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleType",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Manual",
+ "value": "manual"
+ },
+ {
+ "name": "Standard",
+ "value": "standard"
+ }
+ ]
+ }
+ },
+ "ScaleTypeKnownValues": {
+ "type": "string",
+ "enum": [
+ "manual",
+ "standard"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleTypeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Manual",
+ "value": "manual"
+ },
+ {
+ "name": "Standard",
+ "value": "standard"
+ }
+ ]
+ }
+ },
+ "StandardScaleSettings": {
+ "type": "object",
+ "properties": {},
+ "description": "Settings for the standard scale type.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScaleSettings"
+ }
+ ],
+ "x-ms-discriminator-value": "standard"
+ },
+ "State": {
+ "type": "string",
+ "enum": [
+ "notRunning",
+ "running",
+ "succeeded",
+ "canceled",
+ "failed",
+ "deleted"
+ ],
+ "x-ms-enum": {
+ "name": "State",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "NotRunning",
+ "value": "notRunning"
+ },
+ {
+ "name": "Running",
+ "value": "running"
+ },
+ {
+ "name": "Succeeded",
+ "value": "succeeded"
+ },
+ {
+ "name": "Canceled",
+ "value": "canceled"
+ },
+ {
+ "name": "Failed",
+ "value": "failed"
+ },
+ {
+ "name": "Deleted",
+ "value": "deleted"
+ }
+ ]
+ }
+ },
+ "TypeDiscriminator": {
+ "type": "string",
+ "enum": [
+ "list",
+ "fine-tune",
+ "file",
+ "fine-tune-event",
+ "model",
+ "deployment"
+ ],
+ "x-ms-enum": {
+ "name": "TypeDiscriminator",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "List",
+ "value": "list"
+ },
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "File",
+ "value": "file"
+ },
+ {
+ "name": "FineTuneEvent",
+ "value": "fine-tune-event"
+ },
+ {
+ "name": "Model",
+ "value": "model"
+ },
+ {
+ "name": "Deployment",
+ "value": "deployment"
+ }
+ ]
+ }
+ },
+ "TypeDiscriminatorKnownValues": {
+ "type": "string",
+ "enum": [
+ "list",
+ "fine-tune",
+ "file",
+ "fine-tune-event",
+ "model",
+ "deployment"
+ ],
+ "x-ms-enum": {
+ "name": "TypeDiscriminatorKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "List",
+ "value": "list"
+ },
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "File",
+ "value": "file"
+ },
+ {
+ "name": "FineTuneEvent",
+ "value": "fine-tune-event"
+ },
+ {
+ "name": "Model",
+ "value": "model"
+ },
+ {
+ "name": "Deployment",
+ "value": "deployment"
+ }
+ ]
+ }
+ },
+ "Versions": {
+ "type": "string",
+ "enum": [
+ "2022-06-01-preview"
+ ],
+ "x-ms-enum": {
+ "name": "Versions",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "v2022_06_01_preview",
+ "value": "2022-06-01-preview"
+ }
+ ]
+ }
+ }
+ },
+ "parameters": {
+ "Azure.Core.Foundations.ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "description": "The API version to use for this operation.",
+ "minLength": 1,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json
new file mode 100644
index 000000000000..e1eea43f5ede
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json
@@ -0,0 +1,2081 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Azure OpenAI API",
+ "version": "2022-06-01-preview",
+ "description": "API for managing and utilizing Azure Open AI endpoints",
+ "x-cadl-generated": [
+ {
+ "emitter": "@azure-tools/cadl-autorest"
+ }
+ ]
+ },
+ "schemes": [
+ "https"
+ ],
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{endpoint}/openai",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "name": "endpoint",
+ "in": "path",
+ "required": true,
+ "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://westus.api.cognitive.microsoft.com).",
+ "type": "string"
+ }
+ ]
+ },
+ "produces": [
+ "application/json"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "ApiKeyAuth": []
+ },
+ {
+ "OAuth2Auth": []
+ }
+ ],
+ "securityDefinitions": {
+ "ApiKeyAuth": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "apiKey"
+ },
+ "OAuth2Auth": {
+ "type": "oauth2",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+ "scopes": {}
+ }
+ },
+ "tags": [],
+ "paths": {
+ "/deployments": {
+ "get": {
+ "operationId": "Deployments_List",
+ "summary": "Gets the list of deployments owned by the Azure OpenAI resource.",
+ "description": "Gets the list of deployments owned by the Azure OpenAI resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "Deployments_Create",
+ "summary": "Creates a new deployment for the Azure OpenAI resource according to the given\nspecification.",
+ "description": "Creates a new deployment for the Azure OpenAI resource according to the given\nspecification.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "The template for adding updateable properties.",
+ "required": [
+ "scaleSettings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrReplaceModel"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "Location": {
+ "description": "The location of an instance of Deployment",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "required": [
+ "id",
+ "scaleSettings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.CustomResponseFields<(anonymous model)>"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/deployments/{deploymentId}": {
+ "get": {
+ "operationId": "Deployments_Get",
+ "summary": "Gets details for a single deployment specified by the given deploymentId.",
+ "description": "Gets details for a single deployment specified by the given deploymentId.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "operationId": "Deployments_Update",
+ "summary": "Updates the mutable details of the deployment with the given deploymentId.",
+ "description": "Updates the mutable details of the deployment with the given deploymentId.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "The template for adding optional properties.",
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrUpdateModel"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "required": [
+ "id",
+ "scaleSettings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceOkResponse"
+ }
+ },
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "A resource was successfully created.",
+ "required": [
+ "id",
+ "scaleSettings"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreatedResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ },
+ "consumes": [
+ "application/merge-patch+json"
+ ]
+ },
+ "delete": {
+ "operationId": "Deployments_Delete",
+ "summary": "Deletes the deployment specified by the given deploymentId.",
+ "description": "Deletes the deployment specified by the given deploymentId.",
+ "parameters": [
+ {
+ "name": "deploymentId",
+ "in": "path",
+ "required": true,
+ "description": "The identifier of the deployment",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/files": {
+ "get": {
+ "operationId": "Files_List",
+ "summary": "Gets a list of all files owned by the Azure OpenAI resource.\nThese include user uploaded content like files with purpose \"fine-tune\" for training or\nvalidation of fine-tunes models as well as files that are generated by the\nservice such as \"fine-tune-results\" which contains various metrics for the\ncorresponding fine-tune job.",
+ "description": "Gets a list of all files owned by the Azure OpenAI resource.\nThese include user uploaded content like files with purpose \"fine-tune\" for training or\nvalidation of fine-tunes models\nas well as files that are generated by the\nservice such as \"fine-tune-results\" which contains various metrics for the\ncorresponding fine-tune job.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FileList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "Files_Upload",
+ "summary": "Creates a new file entity by uploading data from a local machine. Uploaded\nfiles can, for example, be used for training or evaluating fine-tuned models.",
+ "description": "Creates a new file entity by uploading data from a local machine. Uploaded\nfiles can, for example, be used for training or evaluating fine-tuned models.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "description": "The template for adding updateable properties.",
+ "required": [
+ "purpose",
+ "filename"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.ResourceCreateOrReplaceModel"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "Location": {
+ "description": "The location of an instance of File",
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "schema": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "bytes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of this file when available (can be null). File sizes larger than\n2^53-1 are not supported to ensure compatibility\nwith JavaScript integers.",
+ "readOnly": true
+ },
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "required": [
+ "id",
+ "purpose",
+ "filename"
+ ],
+ "x-cadl-name": "Azure.Core.Foundations.CustomResponseFields<(anonymous model)>"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/files/{fileId}": {
+ "get": {
+ "operationId": "Files_Get",
+ "summary": "Gets details for a single file specified by the given fileId including status,\nsize, purpose, etc.",
+ "description": "Gets details for a single file specified by the given fileId including status,\nsize, purpose, etc.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/File"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "Files_Delete",
+ "summary": "Deletes the file with the given fileId.\nDeletion is also allowed if a file\nwas used, e.g., as training file in a fine-tune job.",
+ "description": "Deletes the file with the given fileId.\nDeletion is also allowed if a file\nwas used, e.g., as training file in a fine-tune job.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/files/{fileId}/content": {
+ "get": {
+ "operationId": "Files_GetFileContent",
+ "summary": "Gets the content of the file specified by the given fileId.\nFiles can be user\nuploaded content or generated by the service like result metrics of a fine-tune\njob.",
+ "description": "Gets the content of the file specified by the given fileId.\nFiles can be user\nuploaded content or generated by the service like result metrics of a fine-tune\njob.",
+ "parameters": [
+ {
+ "name": "fileId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FileContent"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/files/import": {
+ "post": {
+ "operationId": "Files_Import",
+ "summary": "Creates a new file entity by importing data from a provided url. Uploaded files\ncan, for example, be used for training or evaluating fine-tuned models.",
+ "description": "Creates a new file entity by importing data from a provided url. Uploaded files\ncan, for example, be used for training or evaluating fine-tuned models.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "required": true,
+ "description": "expected schema for the body of the completion post request",
+ "schema": {
+ "$ref": "#/definitions/FileImport"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "location": {
+ "description": "Location of the newly created item",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/File"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes": {
+ "get": {
+ "operationId": "FineTunes_List",
+ "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\nThe details that are returned for each fine-tune job contain besides its\nidentifier the base model, training and validation files, hyper parameters,\ntime stamps, status and events. Events are created when the job status\nchanges, e.g. running or complete, and when results are uploaded.",
+ "description": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\nThe details that are returned for each fine-tune job contain besides its\nidentifier the base model, training and validation files, hyper parameters,\ntime stamps, status and events. Events are created when the job status\nchanges, e.g. running or complete, and when results are uploaded.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTuneList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "post": {
+ "operationId": "FineTunes_Create",
+ "summary": "Creates a job that fine-tunes a specified model from a given training\nfile.\nResponse includes details of the enqueued job including job status and\nhyper parameters.\nThe name of the fine-tuned model is added to the response\nonce complete.",
+ "description": "Creates a job that fine-tunes a specified model from a given training\nfile.\nResponse includes details of the enqueued job including job status and\nhyper parameters.\nThe name of the fine-tuned model is added to the response\nonce complete.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ },
+ {
+ "name": "body",
+ "in": "body",
+ "schema": {
+ "$ref": "#/definitions/FineTuneCreation"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request has succeeded and a new resource has been created as a result.",
+ "headers": {
+ "location": {
+ "description": "Location of the newly created item",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}": {
+ "get": {
+ "operationId": "FineTunes_Get",
+ "summary": "Gets details for a single fine-tune job specified by the given\nfineTuneId.\nThe details contain the base model, training and validation\nfiles, hyper parameters, time stamps, status and events.\nEvents are created\nwhen the job status changes, e.g. running or complete, and when results are\nuploaded.",
+ "description": "Gets details for a single fine-tune job specified by the given\nfineTuneId.\nThe details contain the base model, training and validation\nfiles, hyper parameters, time stamps, status and events.\nEvents are created\nwhen the job status changes, e.g. running or complete, and when results are\nuploaded.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "operationId": "FineTunes_Delete",
+ "summary": "Deletes the fine-tune job specified by the given fineTuneId.",
+ "description": "Deletes the fine-tune job specified by the given fineTuneId.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}/cancel": {
+ "post": {
+ "operationId": "FineTunes_Cancel",
+ "summary": "Cancels the processing of the fine-tune job specified by the given fineTuneId.",
+ "description": "Cancels the processing of the fine-tune job specified by the given fineTuneId.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/FineTune"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/fine-tunes/{fineTuneId}/events": {
+ "get": {
+ "operationId": "FineTunes_ListEvents",
+ "summary": "List events for the fine-tune job specified by the given fineTuneId.\nEvents are created when the job status changes, e.g. running or\ncomplete, and when results are uploaded.",
+ "description": "List events for the fine-tune job specified by the given fineTuneId.\nEvents are created when the job status changes, e.g. running or\ncomplete, and when results are uploaded.",
+ "parameters": [
+ {
+ "name": "fineTuneId",
+ "in": "path",
+ "required": true,
+ "description": "fine tune id for which to get events",
+ "type": "string"
+ },
+ {
+ "name": "stream",
+ "in": "query",
+ "required": true,
+ "description": "A flag indicating whether to stream events for the fine-tune job. If set to true,\nevents will be sent as data-only server-sent events as they become available. The stream will terminate with\na data: [DONE] message when the job is finished (succeeded, cancelled, or failed).\nIf set to false, only events generated so far will be returned..",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/EventList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models": {
+ "get": {
+ "operationId": "Models_List",
+ "summary": "Gets a list of all models that are accessible by the Azure OpenAI\nresource.\nThese include base models as well as all successfully completed\nfine-tuned models owned by the Azure OpenAI resource.",
+ "description": "Gets a list of all models that are accessible by the Azure OpenAI\nresource.\nThese include base models as well as all successfully completed\nfine-tuned models owned by the Azure OpenAI resource.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/ModelList"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models/{model_id}": {
+ "get": {
+ "operationId": "Models_Get",
+ "summary": "Gets details for the model specified by the given model_id.",
+ "description": "Gets details for the model specified by the given model_id.",
+ "parameters": [
+ {
+ "name": "model_id",
+ "in": "path",
+ "required": true,
+ "description": "The identity of this item.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Model"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AcceptedResponse": {
+ "type": "object",
+ "properties": {},
+ "description": "Accepted Response"
+ },
+ "Azure.Core.Foundations.Error": {
+ "type": "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",
+ "items": {
+ "$ref": "#/definitions/Azure.Core.Foundations.Error"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Azure.Core.Foundations.Error[]",
+ "description": "An array of details about specific errors that led to this reported error."
+ },
+ "innererror": {
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
+ "description": "An object containing more specific information than the current object about the error."
+ }
+ },
+ "description": "The error object.",
+ "required": [
+ "code",
+ "message",
+ "details"
+ ]
+ },
+ "Azure.Core.Foundations.ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Azure.Core.Foundations.Error",
+ "description": "The error object."
+ }
+ },
+ "description": "A response containing error details.",
+ "required": [
+ "error"
+ ]
+ },
+ "Azure.Core.Foundations.InnerError": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "One of a server-defined set of error codes."
+ },
+ "innererror": {
+ "$ref": "#/definitions/Azure.Core.Foundations.InnerError",
+ "description": "Inner error."
+ }
+ },
+ "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.",
+ "required": [
+ "code"
+ ]
+ },
+ "Capabilities": {
+ "type": "object",
+ "properties": {
+ "fineTune": {
+ "type": "boolean",
+ "description": "A value indicating whether a model can be used for fine tuning.",
+ "readOnly": true
+ },
+ "inference": {
+ "type": "boolean",
+ "description": "A value indicating whether a model can be deployed.",
+ "readOnly": true
+ },
+ "completion": {
+ "type": "boolean",
+ "description": "A value indicating whether a model supports completion.",
+ "readOnly": true
+ },
+ "embeddings": {
+ "type": "boolean",
+ "description": "A value indicating whether a model supports embeddings.",
+ "readOnly": true
+ },
+ "scaleTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScaleType"
+ },
+ "x-cadl-name": "ScaleType[]",
+ "description": "The supported scale types for deployments of this model.",
+ "readOnly": true
+ }
+ },
+ "description": "The capabilities of a base or fine tune model."
+ },
+ "Deployment": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier of the deployment",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The OpenAI model to deploy. Can be a base model or a fine tune."
+ },
+ "owner": {
+ "type": "string",
+ "description": "The owner of this deployment. For Azure OpenAI only \"organization-owner\" is\nsupported.",
+ "readOnly": true
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettings",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "Deployments manage the reserved quota for Azure OpenAI models and make them\navailable for inference requests.",
+ "required": [
+ "id",
+ "scaleSettings"
+ ]
+ },
+ "DeploymentList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "x-cadl-name": "Deployment[]",
+ "description": "The list of items.",
+ "readOnly": true
+ }
+ },
+ "description": "Represents a list of deployments."
+ },
+ "DeploymentUpdate": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The new OpenAI model to be used for this deployment. Can be a base model or a\nfine tune."
+ },
+ "scaleSettings": {
+ "$ref": "#/definitions/ScaleSettingsUpdate",
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity."
+ }
+ },
+ "description": "Defines changes to the deployment."
+ },
+ "Deprecation": {
+ "type": "object",
+ "properties": {
+ "fineTuneEndDate": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The end date of fine tune support of this model. Will be `null` for fine tune\nmodels.",
+ "readOnly": true
+ },
+ "inference": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The end date of inference support of this model.",
+ "readOnly": true
+ }
+ },
+ "description": "Defines the dates of deprecation for the different use cases of a\nmodel.\nUsually base models support 1 year of fine tuning after creation.\nInference is typically supported 2 years after creation of base or\nfine tuned\nmodels. The exact dates are specified in the properties."
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "$ref": "#/definitions/ErrorCode",
+ "description": "Error codes as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ },
+ "message": {
+ "type": "string",
+ "description": "The message of this error."
+ },
+ "target": {
+ "type": "string",
+ "description": "The location where the error happened if available."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Error[]",
+ "description": "The error details if available."
+ },
+ "innererror": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Inner error as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ }
+ },
+ "description": "Error content as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).",
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "ErrorCode": {
+ "type": "string",
+ "enum": [
+ "conflict",
+ "invalidPayload",
+ "forbidden",
+ "notFound",
+ "unexpectedEntityState",
+ "itemDoesAlreadyExist",
+ "serviceUnavailable",
+ "internalFailure",
+ "quotaExceeded"
+ ],
+ "x-ms-enum": {
+ "name": "ErrorCode",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Conflict",
+ "value": "conflict"
+ },
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ },
+ {
+ "name": "Forbidden",
+ "value": "forbidden"
+ },
+ {
+ "name": "NotFound",
+ "value": "notFound"
+ },
+ {
+ "name": "UnexpectedEntityState",
+ "value": "unexpectedEntityState"
+ },
+ {
+ "name": "ItemDoesAlreadyExist",
+ "value": "itemDoesAlreadyExist"
+ },
+ {
+ "name": "ServiceUnavailable",
+ "value": "serviceUnavailable"
+ },
+ {
+ "name": "InternalFailure",
+ "value": "internalFailure"
+ },
+ {
+ "name": "QuotaExceeded",
+ "value": "quotaExceeded"
+ }
+ ]
+ }
+ },
+ "ErrorCodeKnownValues": {
+ "type": "string",
+ "enum": [
+ "conflict",
+ "invalidPayload",
+ "forbidden",
+ "notFound",
+ "unexpectedEntityState",
+ "itemDoesAlreadyExist",
+ "serviceUnavailable",
+ "internalFailure",
+ "quotaExceeded"
+ ],
+ "x-ms-enum": {
+ "name": "ErrorCodeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Conflict",
+ "value": "conflict"
+ },
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ },
+ {
+ "name": "Forbidden",
+ "value": "forbidden"
+ },
+ {
+ "name": "NotFound",
+ "value": "notFound"
+ },
+ {
+ "name": "UnexpectedEntityState",
+ "value": "unexpectedEntityState"
+ },
+ {
+ "name": "ItemDoesAlreadyExist",
+ "value": "itemDoesAlreadyExist"
+ },
+ {
+ "name": "ServiceUnavailable",
+ "value": "serviceUnavailable"
+ },
+ {
+ "name": "InternalFailure",
+ "value": "internalFailure"
+ },
+ {
+ "name": "QuotaExceeded",
+ "value": "quotaExceeded"
+ }
+ ]
+ }
+ },
+ "ErrorResponse": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "Error content as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ }
+ },
+ "description": "Error response as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ },
+ "Event": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this event was created (in unix epochs).",
+ "readOnly": true
+ },
+ "level": {
+ "$ref": "#/definitions/LogLevel",
+ "description": "The verbosity level of an event.",
+ "readOnly": true
+ },
+ "message": {
+ "type": "string",
+ "description": "The message describing the event. This can be a change of state, e.g.,\nenqueued, started, failed or completed, or other events like uploaded results.",
+ "readOnly": true
+ }
+ },
+ "description": "Event"
+ },
+ "EventList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Event[]",
+ "description": "The list of items.",
+ "readOnly": true
+ }
+ },
+ "description": "Represents a list of events."
+ },
+ "File": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "bytes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size of this file when available (can be null). File sizes larger than\n2^53-1 are not supported to ensure compatibility\nwith JavaScript integers.",
+ "readOnly": true
+ },
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the file."
+ }
+ },
+ "description": "A file is a document usable for training and validation. It can also be a\nservice generated document with result details.",
+ "required": [
+ "id",
+ "purpose",
+ "filename"
+ ]
+ },
+ "FileContent": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "file": {
+ "type": "string",
+ "format": "byte",
+ "description": "Gets or sets the file to upload into Azure OpenAI."
+ }
+ },
+ "description": "content of uploaded file",
+ "required": [
+ "purpose",
+ "file"
+ ]
+ },
+ "FileImport": {
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "$ref": "#/definitions/Purpose",
+ "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for\nfine-tuning. This allows us to validate the format of the uploaded file."
+ },
+ "filename": {
+ "type": "string",
+ "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file\nto be uploaded.\nIf the `purpose` is set to \"fine-tune\", each line is a JSON\nrecord with \"prompt\" and \"completion\" fields representing your training\nexamples."
+ },
+ "content_url": {
+ "type": "string",
+ "description": "The url to download the document from (can be SAS url of a blob or any other\nexternal url accessible with a GET request)."
+ }
+ },
+ "description": "Defines a document to import from an external content url to be usable with\nAzure OpenAI.",
+ "required": [
+ "purpose",
+ "filename",
+ "content_url"
+ ]
+ },
+ "FileList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The list of items.",
+ "readOnly": true
+ }
+ },
+ "description": "Represents a list of files."
+ },
+ "FineTune": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The identifier of the base model used for the fine-tune."
+ },
+ "fine_tuned_model": {
+ "type": "string",
+ "description": "The identifier of the resulting fine tuned model. This property is only\npopulated for successfully completed fine-tune runs.\nUse this identifier to\ncreate a deployment for inferencing.",
+ "readOnly": true
+ },
+ "training_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The files that are used for training the fine tuned model."
+ },
+ "validation_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The files that are used to evaluate the fine tuned model during training."
+ },
+ "result_files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/File"
+ },
+ "x-cadl-name": "File[]",
+ "description": "The result files containing training and evaluation metrics in csv format.\nThe\nfile is only available for successfully completed fine-tune runs.",
+ "readOnly": true
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ },
+ "x-ms-identifiers": [],
+ "x-cadl-name": "Event[]",
+ "description": "The events that show the progress of the fine-tune run including queued,\nrunning and completed.",
+ "readOnly": true
+ },
+ "organisation_id": {
+ "type": "string",
+ "description": "The organisation id of this fine tune job. Unused on Azure OpenAI;\ncompatibility for OpenAI only.",
+ "readOnly": true
+ },
+ "user_id": {
+ "type": "string",
+ "description": "The user id of this fine tune job. Unused on Azure OpenAI; compatibility for\nOpenAI only.",
+ "readOnly": true
+ },
+ "hyperparams": {
+ "$ref": "#/definitions/HyperParameters",
+ "description": "The hyper parameter settings used in a fine tune job."
+ }
+ },
+ "description": "Fine tuning is a job to tailor a model to specific training data.",
+ "required": [
+ "id",
+ "model",
+ "training_files"
+ ]
+ },
+ "FineTuneCreation": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "type": "string",
+ "description": "The identifier of the base model used for this fine-tune."
+ },
+ "training_file": {
+ "type": "string",
+ "description": "The file that is used for training this fine tuned model."
+ },
+ "validation_file": {
+ "type": "string",
+ "description": "The file that is used to evaluate the fine tuned model during training."
+ },
+ "hyperparams": {
+ "$ref": "#/definitions/HyperParameters",
+ "description": "The hyper parameter settings used in a fine tune job."
+ }
+ },
+ "description": "Defines the values of a fine tune job.",
+ "required": [
+ "model",
+ "training_file"
+ ]
+ },
+ "FineTuneList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FineTune"
+ },
+ "x-cadl-name": "FineTune[]",
+ "description": "The list of items.",
+ "readOnly": true
+ }
+ },
+ "description": "Represents a list of fine tunes."
+ },
+ "HyperParameters": {
+ "type": "object",
+ "properties": {
+ "batch_size": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The batch size to use for training. The batch size is the number of training\nexamples used to train a single forward and backward pass.\nIn general, we've\nfound that larger batch sizes tend to work better for larger datasets.\nThe\ndefault value as well as the maximum value for this property are specific to a\nbase model."
+ },
+ "learning_rate_multiplier": {
+ "type": "number",
+ "format": "float",
+ "description": "The learning rate multiplier to use for training. The fine-tuning learning rate\nis the original learning rate used for pre-training multiplied by this\nvalue.\nLarger learning rates tend to perform better with larger batch\nsizes.\nWe recommend experimenting with values in the range 0.02 to 0.2 to see\nwhat produces the best results."
+ },
+ "n_epochs": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset."
+ },
+ "prompt_loss_weight": {
+ "type": "number",
+ "format": "float",
+ "description": "The weight to use for loss on the prompt tokens. This controls how much the\nmodel tries to learn to generate the prompt\n(as compared to the completion\nwhich always has a weight of 1.0), and can add a stabilizing effect to training\nwhen completions are short.\nIf prompts are extremely long (relative to\ncompletions), it may make sense to reduce this weight so as to avoid\nover-prioritizing learning the prompt."
+ },
+ "compute_classification_metrics": {
+ "type": "boolean",
+ "description": "A value indicating whether to compute classification metrics.\nIf set, we\ncalculate classification-specific metrics such as accuracy and F-1 score using\nthe validation set at the end of every epoch.\nThese metrics can be viewed in\nthe results file. In order to compute classification metrics, you must provide\na validation_file.Additionally,\nyou must specify classification_n_classes for\nmulticlass classification or classification_positive_class for binary\nclassification."
+ },
+ "classification_n_classes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of classes in a classification task.\nThis parameter is required for\nmulticlass classification."
+ },
+ "classification_positive_class": {
+ "type": "string",
+ "description": "The positive class in binary classification.\nThis parameter is needed to\ngenerate precision, recall, and F1 metrics when doing binary classification."
+ },
+ "classification_betas": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "format": "float"
+ },
+ "x-cadl-name": "float32[]",
+ "description": "The classification beta values. If this is provided, we calculate F-beta scores\nat the specified beta values.\nThe F-beta score is a generalization of F-1\nscore. This is only used for binary classification.\nWith a beta of 1 (i.e.the\nF-1 score), precision and recall are given the same weight.\nA larger beta\nscore puts more weight on recall and less on precision. A smaller beta score\nputs more weight on precision and less on recall."
+ }
+ },
+ "description": "The hyper parameter settings used in a fine tune job."
+ },
+ "InnerError": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "$ref": "#/definitions/InnerErrorCode",
+ "description": "Inner error codes as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ },
+ "innererror": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Inner error as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ }
+ },
+ "description": "Inner error as defined in the Microsoft REST guidelines\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)."
+ },
+ "InnerErrorCode": {
+ "type": "string",
+ "enum": [
+ "invalidPayload"
+ ],
+ "x-ms-enum": {
+ "name": "InnerErrorCode",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ }
+ ]
+ }
+ },
+ "InnerErrorCodeKnownValues": {
+ "type": "string",
+ "enum": [
+ "invalidPayload"
+ ],
+ "x-ms-enum": {
+ "name": "InnerErrorCodeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "InvalidPayload",
+ "value": "invalidPayload"
+ }
+ ]
+ }
+ },
+ "LogLevel": {
+ "type": "string",
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Info",
+ "value": "info"
+ },
+ {
+ "name": "Warning",
+ "value": "warning"
+ },
+ {
+ "name": "Error",
+ "value": "error"
+ }
+ ]
+ }
+ },
+ "ManualScaleSettings": {
+ "type": "object",
+ "properties": {
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The constant reserved capacity of the inference endpoint for this deployment."
+ }
+ },
+ "description": "Settings for the manual scale type.",
+ "required": [
+ "capacity"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScaleSettings"
+ }
+ ],
+ "x-ms-discriminator-value": "manual"
+ },
+ "ManualScaleSettingsUpdate": {
+ "type": "object",
+ "properties": {
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The constant reserved capacity of the inference endpoint for this deployment."
+ }
+ },
+ "description": "Settings for the manual scale type.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScaleSettingsUpdate"
+ }
+ ],
+ "x-ms-discriminator-value": "manual"
+ },
+ "Model": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "status": {
+ "$ref": "#/definitions/State",
+ "description": "The state of a job or item.",
+ "readOnly": true
+ },
+ "createdAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was created (in unix epochs).",
+ "readOnly": true
+ },
+ "updatedAt": {
+ "type": "integer",
+ "format": "int32",
+ "description": "A timestamp when this job or item was modified last (in unix epochs).",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The identity of this item.",
+ "readOnly": true
+ },
+ "model": {
+ "type": "string",
+ "description": "The base model ID if this is a fine tune model; otherwise `null`.",
+ "readOnly": true
+ },
+ "fineTuneId": {
+ "type": "string",
+ "description": "The fine tune job ID if this is a fine tune model; otherwise `null`.",
+ "readOnly": true
+ },
+ "capabilities": {
+ "$ref": "#/definitions/Capabilities",
+ "description": "The capabilities of a base or fine tune model."
+ },
+ "deprecation": {
+ "$ref": "#/definitions/Deprecation",
+ "description": "Defines the dates of deprecation for the different use cases of a\nmodel.\nUsually base models support 1 year of fine tuning after creation.\nInference is typically supported 2 years after creation of base or\nfine tuned\nmodels. The exact dates are specified in the properties."
+ }
+ },
+ "description": "A model is either a base model or the result of a successful fine tune job.",
+ "required": [
+ "id"
+ ]
+ },
+ "ModelList": {
+ "type": "object",
+ "properties": {
+ "object": {
+ "$ref": "#/definitions/TypeDiscriminator",
+ "description": "Defines the type of an object.",
+ "readOnly": true
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Model"
+ },
+ "x-cadl-name": "Model[]",
+ "description": "The list of items.",
+ "readOnly": true
+ }
+ },
+ "description": "Represents a list of models."
+ },
+ "Purpose": {
+ "type": "string",
+ "enum": [
+ "fine-tune",
+ "fine-tune-results"
+ ],
+ "x-ms-enum": {
+ "name": "Purpose",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "FineTuneResults",
+ "value": "fine-tune-results"
+ }
+ ]
+ }
+ },
+ "PurposeKnownValues": {
+ "type": "string",
+ "enum": [
+ "fine-tune",
+ "fine-tune-results"
+ ],
+ "x-ms-enum": {
+ "name": "PurposeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "FineTuneResults",
+ "value": "fine-tune-results"
+ }
+ ]
+ }
+ },
+ "ScaleSettings": {
+ "type": "object",
+ "properties": {
+ "scaleType": {
+ "type": "string",
+ "description": "Discriminator property for ScaleSettings."
+ }
+ },
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity.",
+ "discriminator": "scaleType",
+ "required": [
+ "scaleType"
+ ]
+ },
+ "ScaleSettingsUpdate": {
+ "type": "object",
+ "properties": {
+ "scaleType": {
+ "type": "string",
+ "description": "Discriminator property for ScaleSettingsUpdate."
+ }
+ },
+ "description": "The scale settings of a deployment. It defines the modes for scaling and the\nreserved capacity.",
+ "discriminator": "scaleType",
+ "required": [
+ "scaleType"
+ ]
+ },
+ "ScaleType": {
+ "type": "string",
+ "enum": [
+ "manual",
+ "standard"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleType",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "Manual",
+ "value": "manual"
+ },
+ {
+ "name": "Standard",
+ "value": "standard"
+ }
+ ]
+ }
+ },
+ "ScaleTypeKnownValues": {
+ "type": "string",
+ "enum": [
+ "manual",
+ "standard"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleTypeKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "Manual",
+ "value": "manual"
+ },
+ {
+ "name": "Standard",
+ "value": "standard"
+ }
+ ]
+ }
+ },
+ "StandardScaleSettings": {
+ "type": "object",
+ "properties": {},
+ "description": "Settings for the standard scale type.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScaleSettings"
+ }
+ ],
+ "x-ms-discriminator-value": "standard"
+ },
+ "State": {
+ "type": "string",
+ "enum": [
+ "notRunning",
+ "running",
+ "succeeded",
+ "canceled",
+ "failed",
+ "deleted"
+ ],
+ "x-ms-enum": {
+ "name": "State",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "NotRunning",
+ "value": "notRunning"
+ },
+ {
+ "name": "Running",
+ "value": "running"
+ },
+ {
+ "name": "Succeeded",
+ "value": "succeeded"
+ },
+ {
+ "name": "Canceled",
+ "value": "canceled"
+ },
+ {
+ "name": "Failed",
+ "value": "failed"
+ },
+ {
+ "name": "Deleted",
+ "value": "deleted"
+ }
+ ]
+ }
+ },
+ "TypeDiscriminator": {
+ "type": "string",
+ "enum": [
+ "list",
+ "fine-tune",
+ "file",
+ "fine-tune-event",
+ "model",
+ "deployment"
+ ],
+ "x-ms-enum": {
+ "name": "TypeDiscriminator",
+ "modelAsString": true,
+ "values": [
+ {
+ "name": "List",
+ "value": "list"
+ },
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "File",
+ "value": "file"
+ },
+ {
+ "name": "FineTuneEvent",
+ "value": "fine-tune-event"
+ },
+ {
+ "name": "Model",
+ "value": "model"
+ },
+ {
+ "name": "Deployment",
+ "value": "deployment"
+ }
+ ]
+ }
+ },
+ "TypeDiscriminatorKnownValues": {
+ "type": "string",
+ "enum": [
+ "list",
+ "fine-tune",
+ "file",
+ "fine-tune-event",
+ "model",
+ "deployment"
+ ],
+ "x-ms-enum": {
+ "name": "TypeDiscriminatorKnownValues",
+ "modelAsString": false,
+ "values": [
+ {
+ "name": "List",
+ "value": "list"
+ },
+ {
+ "name": "FineTune",
+ "value": "fine-tune"
+ },
+ {
+ "name": "File",
+ "value": "file"
+ },
+ {
+ "name": "FineTuneEvent",
+ "value": "fine-tune-event"
+ },
+ {
+ "name": "Model",
+ "value": "model"
+ },
+ {
+ "name": "Deployment",
+ "value": "deployment"
+ }
+ ]
+ }
+ }
+ },
+ "parameters": {
+ "Azure.Core.Foundations.ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "description": "The API version to use for this operation.",
+ "minLength": 1,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/cadl-project.yaml b/specification/cognitiveservices/OpenAI.Authoring/cadl-project.yaml
new file mode 100644
index 000000000000..038846db6a36
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/cadl-project.yaml
@@ -0,0 +1,16 @@
+emit:
+ - "@azure-tools/cadl-autorest"
+ - "@azure-tools/cadl-apiview"
+# options:
+# Uncomment this line and add "@azure-tools/cadl-python" to your package.json to generate Python code
+# "@azure-tools/cadl-python":
+# "basic-setup-py": true
+# "package-version":
+# "package-name":
+# "output-path":
+# Uncomment this line and add "@azure-tools/cadl-java" to your package.json to generate Java code
+# "@azure-tools/cadl-java": true
+# Uncomment this line and add "@azure-tools/cadl-csharp" to your package.json to generate C# code
+# "@azure-tools/cadl-csharp": true
+# Uncomment this line and add "@azure-tools/cadl-typescript" to your package.json to generate Typescript code
+# "@azure-tools/cadl-typescript": true
diff --git a/specification/cognitiveservices/OpenAI.Authoring/common.cadl b/specification/cognitiveservices/OpenAI.Authoring/common.cadl
new file mode 100644
index 000000000000..e5d7ee974e1f
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/common.cadl
@@ -0,0 +1,84 @@
+import "@cadl-lang/rest";
+
+using Cadl.Rest;
+using Cadl.Http;
+
+namespace Azure.OpenAI;
+
+// TODO: enum value types not supported in csharp emitter
+enum TypeDiscriminatorKnownValues {
+ List: "list",
+ FineTune: "fine-tune",
+ File: "file",
+ FineTuneEvent: "fine-tune-event",
+ Model: "model",
+ Deployment: "deployment",
+}
+
+@knownValues(TypeDiscriminatorKnownValues)
+scalar TypeDiscriminator extends string;
+
+enum ScaleTypeKnownValues {
+ Manual: "manual",
+ Standard: "standard",
+}
+
+@knownValues(ScaleTypeKnownValues)
+scalar ScaleType extends string;
+
+enum ErrorCodeKnownValues {
+ Conflict: "conflict",
+ InvalidPayload: "invalidPayload",
+ Forbidden: "forbidden",
+ NotFound: "notFound",
+ UnexpectedEntityState: "unexpectedEntityState",
+ ItemDoesAlreadyExist: "itemDoesAlreadyExist",
+ ServiceUnavailable: "serviceUnavailable",
+ InternalFailure: "internalFailure",
+ QuotaExceeded: "quotaExceeded",
+}
+
+@knownValues(ErrorCodeKnownValues)
+scalar ErrorCode extends string;
+
+enum InnerErrorCodeKnownValues {
+ InvalidPayload: "invalidPayload",
+}
+
+@knownValues(InnerErrorCodeKnownValues)
+scalar InnerErrorCode extends string;
+
+enum PurposeKnownValues {
+ FineTune: "fine-tune",
+ FineTuneResults: "fine-tune-results",
+}
+
+@knownValues(PurposeKnownValues)
+scalar Purpose extends string;
+
+enum State {
+ NotRunning: "notRunning",
+ Running: "running",
+ Succeeded: "succeeded",
+ Canceled: "canceled",
+ Failed: "failed",
+ Deleted: "deleted",
+}
+
+enum LogLevel {
+ Info: "info",
+ Warning: "warning",
+ Error: "error",
+}
+
+@doc("Created Response")
+model CreatedResponse {
+ @doc("The status code")
+ @statusCode
+ statusCode: 201;
+
+ @doc("Location of the newly created item")
+ @header
+ @format("uri")
+ location: string;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/deployment.cadl b/specification/cognitiveservices/OpenAI.Authoring/deployment.cadl
new file mode 100644
index 000000000000..f4be6aa7aacf
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/deployment.cadl
@@ -0,0 +1,45 @@
+import "@azure-tools/cadl-azure-core";
+import "./models/deployment.models.cadl";
+import "./serviceCustomizations.cadl";
+
+namespace Azure.OpenAI;
+
+using Cadl.Http;
+using Azure.Core;
+
+interface Deployments {
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("Gets the list of deployments owned by the Azure OpenAI resource.")
+ @doc("Gets the list of deployments owned by the Azure OpenAI resource.")
+ @route("/deployments")
+ @get
+ // TODO: enum value types not supported in csharp emitter, change string literal to TypeDiscriminatorKnownValues enum when fixed
+ ListDeployments is ServiceCustomizations.OpenAIListOperation;
+
+ @summary("""
+Creates a new deployment for the Azure OpenAI resource according to the given
+specification.
+""")
+ @doc("""
+Creates a new deployment for the Azure OpenAI resource according to the given
+specification.
+""")
+ CreateDeployment is ResourceCreateWithServiceProvidedName<
+ Deployment,
+ {
+ response: Deployment
+ }
+ >;
+
+ @summary("Gets details for a single deployment specified by the given deployment_id.")
+ @doc("Gets details for a single deployment specified by the given deployment_id.")
+ GetDeployment is ResourceRead;
+
+ @summary("Updates the mutable details of the deployment with the given deployment_id.")
+ @doc("Updates the mutable details of the deployment with the given deployment_id.")
+ UpdateDeployment is ResourceCreateOrUpdate;
+
+ @summary("Deletes the deployment specified by the given deployment_id.")
+ @doc("Deletes the deployment specified by the given deployment_id.")
+ DeleteDeployment is ResourceDelete;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/file.cadl b/specification/cognitiveservices/OpenAI.Authoring/file.cadl
new file mode 100644
index 000000000000..ab95bcb748f3
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/file.cadl
@@ -0,0 +1,108 @@
+import "@azure-tools/cadl-azure-core";
+import "@cadl-lang/rest";
+import "./models/file.models.cadl";
+import "./serviceCustomizations.cadl";
+
+namespace Azure.OpenAI;
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+
+interface Files
+{
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+Gets a list of all files owned by the Azure OpenAI resource.
+These include user uploaded content like files with purpose "fine-tune" for training or
+validation of fine-tunes models as well as files that are generated by the
+service such as "fine-tune-results" which contains various metrics for the
+corresponding fine-tune job.
+""")
+ @doc("""
+Gets a list of all files owned by the Azure OpenAI resource.
+These include user uploaded content like files with purpose \"fine-tune\" for training or
+validation of fine-tunes models
+as well as files that are generated by the
+service such as \"fine-tune-results\" which contains various metrics for the
+corresponding fine-tune job.
+""")
+ @route("/files")
+ @get
+ // TODO: enum value types not supported in csharp emitter, change string literal to TypeDiscriminatorKnownValues enum when fixed
+ ListFiles is ServiceCustomizations.OpenAIListOperation;
+
+ @summary("""
+Creates a new file entity by uploading data from a local machine. Uploaded
+files can, for example, be used for training or evaluating fine-tuned models.
+""")
+ @doc("""
+Creates a new file entity by uploading data from a local machine. Uploaded
+files can, for example, be used for training or evaluating fine-tuned models.
+""")
+ UploadFile is ResourceCreateWithServiceProvidedName<
+ File,
+ {
+ response: File
+ }
+ >;
+
+ @summary("""
+Gets details for a single file specified by the given file_id including status,
+size, purpose, etc.
+""")
+ @doc("""
+Gets details for a single file specified by the given file_id including status,
+size, purpose, etc.
+""")
+ GetFile is ResourceRead;
+
+ @summary("""
+Deletes the file with the given file_id.
+Deletion is also allowed if a file
+was used, e.g., as training file in a fine-tune job.
+""")
+ @doc("""
+Deletes the file with the given file_id.
+Deletion is also allowed if a file
+was used, e.g., as training file in a fine-tune job.
+""")
+ DeleteFile is ResourceDelete;
+
+ @summary("""
+Gets the content of the file specified by the given file_id.
+Files can be user
+uploaded content or generated by the service like result metrics of a fine-tune
+job.
+""")
+ @doc("""
+Gets the content of the file specified by the given file_id.
+Files can be user
+uploaded content or generated by the service like result metrics of a fine-tune
+job.
+""")
+ @get
+ @action("content")
+ @actionSeparator("/")
+ GetFileContent is ResourceAction;
+
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+Creates a new file entity by importing data from a provided url. Uploaded files
+can, for example, be used for training or evaluating fine-tuned models.
+""")
+ @doc("""
+Creates a new file entity by importing data from a provided url. Uploaded files
+can, for example, be used for training or evaluating fine-tuned models.
+""")
+ @route("/files/import")
+ @post
+ ImportFile is Foundations.Operation<
+ {
+ @doc("expected schema for the body of the completion post request")
+ @body
+ body: FileImport;
+ },
+ File & CreatedResponse
+ >;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/finetune.cadl b/specification/cognitiveservices/OpenAI.Authoring/finetune.cadl
new file mode 100644
index 000000000000..b5c6add50c01
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/finetune.cadl
@@ -0,0 +1,107 @@
+import "@azure-tools/cadl-azure-core";
+import "@cadl-lang/rest";
+import "./models/finetune.models.cadl";
+import "./serviceCustomizations.cadl";
+
+namespace Azure.OpenAI;
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+
+interface FineTunes {
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.
+The details that are returned for each fine-tune job contain besides its
+identifier the base model, training and validation files, hyper parameters,
+time stamps, status and events. Events are created when the job status
+changes, e.g. running or complete, and when results are uploaded.
+""")
+ @doc("""
+Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.
+The details that are returned for each fine-tune job contain besides its
+identifier the base model, training and validation files, hyper parameters,
+time stamps, status and events. Events are created when the job status
+changes, e.g. running or complete, and when results are uploaded.
+""")
+ @route("/fine-tunes")
+ @get
+ // TODO: enum value types not supported in csharp emitter, change string literal to TypeDiscriminatorKnownValues enum when fixed
+ ListFineTunes is ServiceCustomizations.OpenAIListOperation;
+
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+Creates a job that fine-tunes a specified model from a given training
+file.
+Response includes details of the enqueued job including job status and
+hyper parameters.
+The name of the fine-tuned model is added to the response
+once complete.
+""")
+ @doc("""
+Creates a job that fine-tunes a specified model from a given training
+file.
+Response includes details of the enqueued job including job status and
+hyper parameters.
+The name of the fine-tuned model is added to the response
+once complete.
+""")
+ @route("/fine-tunes")
+ @post
+ CreateFineTune is Foundations.Operation<
+ FineTuneCreation,
+ FineTune & CreatedResponse
+ >;
+
+ @summary("""
+Gets details for a single fine-tune job specified by the given
+fine_tune_id.
+The details contain the base model, training and validation
+files, hyper parameters, time stamps, status and events.
+Events are created
+when the job status changes, e.g. running or complete, and when results are
+uploaded.
+""")
+ @doc("""
+Gets details for a single fine-tune job specified by the given
+fine_tune_id.
+The details contain the base model, training and validation
+files, hyper parameters, time stamps, status and events.
+Events are created
+when the job status changes, e.g. running or complete, and when results are
+uploaded.
+""")
+ GetFineTune is ResourceRead;
+
+ @summary("Deletes the fine-tune job specified by the given fine_tune_id.")
+ @doc("Deletes the fine-tune job specified by the given fine_tune_id.")
+ DeleteFineTune is ResourceDelete;
+
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+List events for the fine-tune job specified by the given fine_tune_id.
+Events are created when the job status changes, e.g. running or
+complete, and when results are uploaded.
+""")
+ @doc("""
+List events for the fine-tune job specified by the given fine_tune_id.
+Events are created when the job status changes, e.g. running or
+complete, and when results are uploaded.
+""")
+ @Cadl.Rest.actionSeparator("/")
+ @get
+ ListFineTuneEvents is Azure.Core.ResourceAction>;
+
+ // #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("Cancels the processing of the fine-tune job specified by the given fine_tune_id.")
+ @doc("Cancels the processing of the fine-tune job specified by the given fine_tune_id.")
+ @post
+ @action("cancel")
+ @actionSeparator("/")
+ CancelFineTune is ResourceAction;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/main.cadl b/specification/cognitiveservices/OpenAI.Authoring/main.cadl
new file mode 100644
index 000000000000..4415dd0b151c
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/main.cadl
@@ -0,0 +1,41 @@
+import "@cadl-lang/rest";
+import "@cadl-lang/versioning";
+import "./common.cadl";
+import "./deployment.cadl";
+import "./file.cadl";
+import "./finetune.cadl";
+import "./model.routes.cadl";
+
+using Cadl.Rest;
+using Cadl.Http;
+using Cadl.Versioning;
+
+@useAuth(
+ ApiKeyAuth |
+ OAuth2Auth<[{
+ type: OAuth2FlowType.implicit,
+ authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+ scopes: ["https://cognitiveservices.azure.com/.default"]
+ }]>)
+@service({title: "Azure OpenAI API"})
+@versioned(Azure.OpenAI.Versions)
+@versionedDependency(
+ [[Azure.OpenAI.Versions.v2022_06_01_preview, Azure.Core.Versions.v1_0_Preview_1]]
+)
+@server(
+ "{endpoint}/openai",
+ "API for managing and utilizing Azure Open AI endpoints",
+ {
+ @doc("""
+Supported Cognitive Services endpoints (protocol and hostname, for example:
+https://westus.api.cognitive.microsoft.com).
+""")
+ endpoint: string,
+ }
+)
+@doc("API for managing and utilizing Azure Open AI endpoints")
+namespace Azure.OpenAI;
+
+enum Versions {
+ v2022_06_01_preview: "2022-06-01-preview",
+}
\ No newline at end of file
diff --git a/specification/cognitiveservices/OpenAI.Authoring/model.routes.cadl b/specification/cognitiveservices/OpenAI.Authoring/model.routes.cadl
new file mode 100644
index 000000000000..aa5555c59c63
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/model.routes.cadl
@@ -0,0 +1,34 @@
+import "@azure-tools/cadl-azure-core";
+import "@cadl-lang/rest";
+import "./models/model.models.cadl";
+import "./serviceCustomizations.cadl";
+
+namespace Azure.OpenAI;
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+
+interface Models {
+ #suppress "@azure-tools/cadl-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation."
+ @summary("""
+Gets a list of all models that are accessible by the Azure OpenAI
+resource.
+These include base models as well as all successfully completed
+fine-tuned models owned by the Azure OpenAI resource.
+""")
+ @doc("""
+Gets a list of all models that are accessible by the Azure OpenAI
+resource.
+These include base models as well as all successfully completed
+fine-tuned models owned by the Azure OpenAI resource.
+""")
+ @route("/models")
+ @get
+ // TODO: enum value types not supported in csharp emitter, change string literal to TypeDiscriminatorKnownValues enum when fixed
+ ListModels is ServiceCustomizations.OpenAIListOperation;
+
+ @summary("Gets details for the model specified by the given model_id.")
+ @doc("Gets details for the model specified by the given model_id.")
+ GetModel is ResourceRead;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/models/deployment.models.cadl b/specification/cognitiveservices/OpenAI.Authoring/models/deployment.models.cadl
new file mode 100644
index 000000000000..6adb19b85606
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/models/deployment.models.cadl
@@ -0,0 +1,57 @@
+import "@cadl-lang/rest";
+
+using Cadl.Rest;
+using Cadl.Rest.Resource;
+
+namespace Azure.OpenAI;
+
+@doc("""
+Deployments manage the reserved quota for Azure OpenAI models and make them
+available for inference requests.
+""")
+@resource("deployments")
+model Deployment {
+ @doc("Defines the type of an object.")
+ @visibility("read")
+ object?: TypeDiscriminator;
+
+ @doc("The state of a job or item.")
+ @visibility("read")
+ status: State;
+
+ @doc("A timestamp when this job or item was created (in unix epochs).")
+ @visibility("read")
+ created_at: int32;
+
+ @doc("A timestamp when this job or item was modified last (in unix epochs).")
+ @visibility("read")
+ updated_at: int32;
+
+ @doc("The identifier of the deployment")
+ @key("deploymentId")
+ @visibility("read")
+ id: string;
+
+ @doc("The OpenAI model to deploy. Can be a base model or a fine tune.")
+ "model": string;
+
+ @doc("""
+The owner of this deployment. For Azure OpenAI only \"organization-owner\" is
+supported.
+""")
+ @visibility("read")
+ owner?: string;
+
+ @doc("""
+The scale settings of a deployment. It defines the modes for scaling and the
+reserved capacity.
+""")
+ scale_settings: ScaleSettings;
+}
+
+@doc("""
+The scale settings of a deployment. It defines the modes for scaling and the
+reserved capacity.
+""")
+@discriminator("scale_type")
+model ScaleSettings {}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/models/file.models.cadl b/specification/cognitiveservices/OpenAI.Authoring/models/file.models.cadl
new file mode 100644
index 000000000000..224a2064b223
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/models/file.models.cadl
@@ -0,0 +1,91 @@
+import "@cadl-lang/rest";
+import "@azure-tools/cadl-azure-core";
+
+using Cadl.Rest;
+using Azure.Core;
+
+namespace Azure.OpenAI;
+
+@doc("""
+A file is a document usable for training and validation. It can also be a
+service generated document with result details.
+""")
+@resource("files")
+model File {
+ @doc("Defines the type of an object.")
+ @visibility("read")
+ object?: TypeDiscriminator;
+
+ @doc("The state of a job or item.")
+ @visibility("read")
+ status?: State;
+
+ @doc("A timestamp when this job or item was created (in unix epochs).")
+ @visibility("read")
+ created_at?: int32;
+
+ @doc("A timestamp when this job or item was modified last (in unix epochs).")
+ @visibility("read")
+ updated_at?: int32;
+
+ @doc("The identity of this item.")
+ @visibility("read")
+ @key("fileId")
+ id: string;
+
+ @doc("""
+The size of this file when available (can be null). File sizes larger than
+2^53-1 are not supported to ensure compatibility
+with JavaScript integers.
+""")
+ @visibility("read")
+ bytes?: int32;
+
+ @doc("""
+The intended purpose of the uploaded documents. Use \"fine-tune\" for
+fine-tuning. This allows us to validate the format of the uploaded file.
+""")
+ purpose: Purpose;
+
+ @doc("The name of the file.")
+ filename: string;
+}
+
+@doc("""
+Defines a document to import from an external content url to be usable with
+Azure OpenAI.
+""")
+model FileImport {
+ @doc("""
+The intended purpose of the uploaded documents. Use \"fine-tune\" for
+fine-tuning. This allows us to validate the format of the uploaded file.
+""")
+ purpose: Purpose;
+
+ @doc("""
+The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file
+to be uploaded.
+If the `purpose` is set to \"fine-tune\", each line is a JSON
+record with \"prompt\" and \"completion\" fields representing your training
+examples.
+""")
+ filename: string;
+
+ @doc("""
+The url to download the document from (can be SAS url of a blob or any other
+external url accessible with a GET request).
+""")
+ content_url: string;
+}
+
+@doc("content of uploaded file")
+model FileContent {
+ @doc("""
+The intended purpose of the uploaded documents. Use \"fine-tune\" for
+fine-tuning. This allows us to validate the format of the uploaded file.
+""")
+ purpose: Purpose;
+
+ @doc("Gets or sets the file to upload into Azure OpenAI.")
+ file: bytes;
+}
\ No newline at end of file
diff --git a/specification/cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl b/specification/cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl
new file mode 100644
index 000000000000..9374ad458552
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl
@@ -0,0 +1,204 @@
+import "@cadl-lang/rest";
+import "@azure-tools/cadl-azure-core";
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+
+namespace Azure.OpenAI;
+
+@doc("Fine tuning is a job to tailor a model to specific training data.")
+@resource("fine-tunes")
+model FineTune {
+ @doc("Defines the type of an object.")
+ @visibility("read")
+ object?: TypeDiscriminator;
+
+ @doc("The state of a job or item.")
+ @visibility("read")
+ status?: State;
+
+ @doc("A timestamp when this job or item was created (in unix epochs).")
+ @visibility("read")
+ created_at?: int32;
+
+ @doc("A timestamp when this job or item was modified last (in unix epochs).")
+ @visibility("read")
+ updated_at?: int32;
+
+ @doc("The identity of this item.")
+ @visibility("read")
+ @key("fineTuneId")
+ id: string;
+
+ @doc("The identifier of the base model used for the fine-tune.")
+ "model": string;
+
+ @doc("""
+The identifier of the resulting fine tuned model. This property is only
+populated for successfully completed fine-tune runs.
+Use this identifier to
+create a deployment for inferencing.
+""")
+ @visibility("read")
+ fine_tuned_model?: string;
+
+ @doc("The files that are used for training the fine tuned model.")
+ training_files: File[];
+
+ @doc("The files that are used to evaluate the fine tuned model during training.")
+ validation_files?: File[];
+
+ @doc("""
+The result files containing training and evaluation metrics in csv format.
+The
+file is only available for successfully completed fine-tune runs.
+""")
+ @visibility("read")
+ result_files?: File[];
+
+ @doc("""
+The events that show the progress of the fine-tune run including queued,
+running and completed.
+""")
+ @visibility("read")
+ events?: Event[];
+
+ @doc("""
+The organisation id of this fine tune job. Unused on Azure OpenAI;
+compatibility for OpenAI only.
+""")
+ @visibility("read")
+ organisation_id?: string;
+
+ @doc("""
+The user id of this fine tune job. Unused on Azure OpenAI; compatibility for
+OpenAI only.
+""")
+ @visibility("read")
+ user_id?: string;
+
+ @doc("The hyper parameter settings used in a fine tune job.")
+ hyperparams?: HyperParameters;
+}
+
+@doc("Event")
+model Event {
+ @doc("Defines the type of an object.")
+ @visibility("read")
+ object?: TypeDiscriminator;
+
+ @doc("A timestamp when this event was created (in unix epochs).")
+ @visibility("read")
+ created_at?: int32;
+
+ @doc("The verbosity level of an event.")
+ @visibility("read")
+ level?: LogLevel;
+
+ @doc("""
+The message describing the event. This can be a change of state, e.g.,
+enqueued, started, failed or completed, or other events like uploaded results.
+""")
+ @visibility("read")
+ message?: string;
+}
+
+@doc("The hyper parameter settings used in a fine tune job.")
+model HyperParameters {
+ @doc("""
+The batch size to use for training. The batch size is the number of training
+examples used to train a single forward and backward pass.
+In general, we've
+found that larger batch sizes tend to work better for larger datasets.
+The
+default value as well as the maximum value for this property are specific to a
+base model.
+""")
+ batch_size?: int32;
+
+ @doc("""
+The learning rate multiplier to use for training. The fine-tuning learning rate
+is the original learning rate used for pre-training multiplied by this
+value.
+Larger learning rates tend to perform better with larger batch
+sizes.
+We recommend experimenting with values in the range 0.02 to 0.2 to see
+what produces the best results.
+""")
+ learning_rate_multiplier?: float32;
+
+ @doc("""
+The number of epochs to train the model for. An epoch refers to one full cycle
+through the training dataset.
+""")
+ n_epochs?: int32;
+
+ @doc("""
+The weight to use for loss on the prompt tokens. This controls how much the
+model tries to learn to generate the prompt
+(as compared to the completion
+which always has a weight of 1.0), and can add a stabilizing effect to training
+when completions are short.
+If prompts are extremely long (relative to
+completions), it may make sense to reduce this weight so as to avoid
+over-prioritizing learning the prompt.
+""")
+ prompt_loss_weight?: float32;
+
+ @doc("""
+A value indicating whether to compute classification metrics.
+If set, we
+calculate classification-specific metrics such as accuracy and F-1 score using
+the validation set at the end of every epoch.
+These metrics can be viewed in
+the results file. In order to compute classification metrics, you must provide
+a validation_file.Additionally,
+you must specify classification_n_classes for
+multiclass classification or classification_positive_class for binary
+classification.
+""")
+ compute_classification_metrics?: boolean;
+
+ @doc("""
+The number of classes in a classification task.
+This parameter is required for
+multiclass classification.
+""")
+ classification_n_classes?: int32;
+
+ @doc("""
+The positive class in binary classification.
+This parameter is needed to
+generate precision, recall, and F1 metrics when doing binary classification.
+""")
+ classification_positive_class?: string;
+
+ @doc("""
+The classification beta values. If this is provided, we calculate F-beta scores
+at the specified beta values.
+The F-beta score is a generalization of F-1
+score. This is only used for binary classification.
+With a beta of 1 (i.e.the
+F-1 score), precision and recall are given the same weight.
+A larger beta
+score puts more weight on recall and less on precision. A smaller beta score
+puts more weight on precision and less on recall.
+""")
+ classification_betas?: float32[];
+}
+
+@doc("Defines the values of a fine tune job.")
+model FineTuneCreation {
+ @doc("The identifier of the base model used for this fine-tune.")
+ "model": string;
+
+ @doc("The file that is used for training this fine tuned model.")
+ training_file: string;
+
+ @doc("The file that is used to evaluate the fine tuned model during training.")
+ validation_file?: string;
+
+ @doc("The hyper parameter settings used in a fine tune job.")
+ hyperparams?: HyperParameters;
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/models/model.models.cadl b/specification/cognitiveservices/OpenAI.Authoring/models/model.models.cadl
new file mode 100644
index 000000000000..cd0c84f9d4da
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/models/model.models.cadl
@@ -0,0 +1,113 @@
+import "@cadl-lang/rest";
+import "@azure-tools/cadl-azure-core";
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+
+namespace Azure.OpenAI;
+
+@doc("A model is either a base model or the result of a successful fine tune job.")
+@resource("models")
+model Model {
+ @doc("Defines the type of an object.")
+ @visibility("read")
+ object?: TypeDiscriminator;
+
+ @doc("The state of a job or item.")
+ @visibility("read")
+ status?: State;
+
+ @doc("A timestamp when this job or item was created (in unix epochs).")
+ @visibility("read")
+ created_at?: int32;
+
+ @doc("A timestamp when this job or item was modified last (in unix epochs).")
+ @visibility("read")
+ updated_at?: int32;
+
+ @doc("The identity of this item.")
+ @visibility("read")
+ @key("model_id")
+ id: string;
+
+ @doc("The base model ID if this is a fine tune model; otherwise `null`.")
+ @visibility("read")
+ "model"?: string;
+
+ @doc("The fine tune job ID if this is a fine tune model; otherwise `null`.")
+ @visibility("read")
+ fine_tune?: string;
+
+ @doc("The capabilities of a base or fine tune model.")
+ capabilities?: Capabilities;
+
+ @doc("""
+Defines the dates of deprecation for the different use cases of a
+model.
+Usually base models support 1 year of fine tuning after creation.
+Inference is typically supported 2 years after creation of base or
+fine tuned
+models. The exact dates are specified in the properties.
+""")
+ deprecation?: Deprecation;
+}
+
+@doc("The capabilities of a base or fine tune model.")
+model Capabilities {
+ @doc("A value indicating whether a model can be used for fine tuning.")
+ @visibility("read")
+ fine_tune?: boolean;
+
+ @doc("A value indicating whether a model can be deployed.")
+ @visibility("read")
+ inference?: boolean;
+
+ @doc("A value indicating whether a model supports completion.")
+ @visibility("read")
+ completion?: boolean;
+
+ @doc("A value indicating whether a model supports embeddings.")
+ @visibility("read")
+ embeddings?: boolean;
+
+ @doc("The supported scale types for deployments of this model.")
+ @visibility("read")
+ scale_types?: ScaleType[];
+}
+
+@doc("""
+Defines the dates of deprecation for the different use cases of a
+model.
+Usually base models support 1 year of fine tuning after creation.
+Inference is typically supported 2 years after creation of base or
+fine tuned
+models. The exact dates are specified in the properties.
+""")
+model Deprecation {
+ @doc("""
+The end date of fine tune support of this model. Will be `null` for fine tune
+models.
+""")
+ @visibility("read")
+ fine_tune_end_date?: int32;
+
+ @doc("The end date of inference support of this model.")
+ @visibility("read")
+ inference?: int32;
+}
+
+@doc("Settings for the manual scale type.")
+model ManualScaleSettings extends ScaleSettings {
+ @doc("The constant reserved capacity of the inference endpoint for this deployment.")
+ capacity: int32;
+
+ @doc("Defines how scaling operations will be executed.")
+ scale_type: "manual";
+}
+
+@doc("Settings for the standard scale type.")
+model StandardScaleSettings extends ScaleSettings {
+ @doc("Defines how scaling operations will be executed.")
+ scale_type: "standard";
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/package-lock.json b/specification/cognitiveservices/OpenAI.Authoring/package-lock.json
new file mode 100644
index 000000000000..332f9b6b3cc5
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/package-lock.json
@@ -0,0 +1,1872 @@
+{
+ "name": "@cadl-api-spec/azure-openai-api-version-2022-06-01-preview",
+ "lockfileVersion": 2,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "@cadl-api-spec/azure-openai-api-version-2022-06-01-preview",
+ "license": "MIT",
+ "dependencies": {
+ "@azure-tools/cadl-apiview": "~0.3.1",
+ "@azure-tools/cadl-autorest": "^0.24.0",
+ "@azure-tools/cadl-azure-core": "^0.24.0",
+ "@cadl-lang/compiler": "^0.38.0",
+ "@cadl-lang/prettier-plugin-cadl": "^0.38",
+ "@cadl-lang/rest": "^0.38.0",
+ "@cadl-lang/versioning": "^0.38.0",
+ "prettier": "^2.8.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-apiview": {
+ "version": "0.3.3",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.3.tgz",
+ "integrity": "sha512-j16XUApC2C1HqRSbniJVhH0RUOeCHNE36kQt3TPI46CZQY8M6u/D8Gk3o+7MRQSBQ4QP8n9/h4h6AMAVPKVkew==",
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-autorest": {
+ "version": "0.24.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-autorest/-/cadl-autorest-0.24.0.tgz",
+ "integrity": "sha512-q8A3GRlwyQJ+/8cJs3dzyB4sRSVORItVS27NOraOwaXMudk9W6wW4uwBpyR07B3iHUanC8ZECe6CaCDUUttbtg==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@azure-tools/cadl-azure-core": "~0.24.0",
+ "@cadl-lang/compiler": "~0.38.0",
+ "@cadl-lang/openapi": "~0.38.0",
+ "@cadl-lang/rest": "~0.38.0",
+ "@cadl-lang/versioning": "~0.38.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-azure-core": {
+ "version": "0.24.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-core/-/cadl-azure-core-0.24.0.tgz",
+ "integrity": "sha512-Pzs1uC03Rbd783dAN8yvsFEWKJIBpV7zKf+Mj2S2x7F9IsR+KS1nlPmifIAtSCeSRPVkU21xD1WmzXvB1GR59w==",
+ "dependencies": {
+ "@cadl-lang/lint": "~0.38.0"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.38.0",
+ "@cadl-lang/rest": "~0.38.0"
+ }
+ },
+ "node_modules/@babel/code-frame": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz",
+ "integrity": "sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==",
+ "dependencies": {
+ "@babel/highlight": "^7.18.6"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-validator-identifier": {
+ "version": "7.19.1",
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz",
+ "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/highlight": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.18.6.tgz",
+ "integrity": "sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==",
+ "dependencies": {
+ "@babel/helper-validator-identifier": "^7.18.6",
+ "chalk": "^2.0.0",
+ "js-tokens": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@cadl-lang/compiler": {
+ "version": "0.38.5",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/compiler/-/compiler-0.38.5.tgz",
+ "integrity": "sha512-jd6a8TEp9ApBzekTb39aBPocYrkuqzsQbLTDcc/c6tA47Wmr87463MAXpeB80ziEsr15sccI01j3g63jt5W0Aw==",
+ "dependencies": {
+ "@babel/code-frame": "~7.18.6",
+ "ajv": "~8.11.2",
+ "change-case": "~4.1.2",
+ "globby": "~13.1.1",
+ "js-yaml": "~4.1.0",
+ "mkdirp": "~1.0.4",
+ "mustache": "~4.2.0",
+ "node-fetch": "3.2.8",
+ "node-watch": "~0.7.1",
+ "picocolors": "~1.0.0",
+ "prettier": "~2.7.1",
+ "prompts": "~2.4.1",
+ "vscode-languageserver": "~8.0.2",
+ "vscode-languageserver-textdocument": "~1.0.1",
+ "yargs": "~17.6.2"
+ },
+ "bin": {
+ "cadl": "cmd/cadl.js",
+ "cadl-server": "cmd/cadl-server.js"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@cadl-lang/compiler/node_modules/prettier": {
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+ "bin": {
+ "prettier": "bin-prettier.js"
+ },
+ "engines": {
+ "node": ">=10.13.0"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
+ }
+ },
+ "node_modules/@cadl-lang/lint": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/lint/-/lint-0.38.0.tgz",
+ "integrity": "sha512-6g4yoXeaNnTYxEWA0QywN3HkTCINPTHI56IsDKp6JhLOiROj1NvoufUzX438vdTqDqNyHg2t08fRmLMJP4GsCQ==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.38.0"
+ }
+ },
+ "node_modules/@cadl-lang/openapi": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/openapi/-/openapi-0.38.0.tgz",
+ "integrity": "sha512-lFmU5AsZtw7Ofcnq3lg18Ieg21iuS73NOb+549BxPZX2j70vEqqfRT3CCCFmpGCK2sAUy2x2qD+pVUBcQIXeHQ==",
+ "peer": true,
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.38.0",
+ "@cadl-lang/rest": "~0.38.0"
+ }
+ },
+ "node_modules/@cadl-lang/prettier-plugin-cadl": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/prettier-plugin-cadl/-/prettier-plugin-cadl-0.38.0.tgz",
+ "integrity": "sha512-L4wXsTJukonB4KYEzPC/gpQcOXBGYHsBVgVa8D/Nc6tRRr2QLT+Oih7qpBTsuXgynWTP1EHr3iksbg3Mv91lnA==",
+ "dependencies": {
+ "prettier": "~2.7.1"
+ }
+ },
+ "node_modules/@cadl-lang/prettier-plugin-cadl/node_modules/prettier": {
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
+ "bin": {
+ "prettier": "bin-prettier.js"
+ },
+ "engines": {
+ "node": ">=10.13.0"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
+ }
+ },
+ "node_modules/@cadl-lang/rest": {
+ "version": "0.38.1",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/rest/-/rest-0.38.1.tgz",
+ "integrity": "sha512-bl+AKgX42+1B9bwDq1uORcAhEfkR0oKctMmbdqCZAhWmhWaKWm0JsnEyKQ1Ujfpw2La9DiVg5mgwsQqQ5jiTeA==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.38.3"
+ }
+ },
+ "node_modules/@cadl-lang/versioning": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/versioning/-/versioning-0.38.0.tgz",
+ "integrity": "sha512-7ECvYQShLu80eyQzRgRH1Lu/P1lrjnHpnEcNZK8bVoHoy+QT+DkY/c22OoBRwcb5kux9/T1/CMF61WqfrKC8jQ==",
+ "dependencies": {
+ "@cadl-lang/compiler": "~0.38.0"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "dependencies": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "dependencies": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/ajv": {
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-E4bfmKAhGiSTvMfL1Myyycaub+cUEU2/IvpylXkUu7CHBkBj1f/ikdzbD7YQ6FKUbixDxeYvB/xY4fvyroDlQg==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.1",
+ "json-schema-traverse": "^1.0.0",
+ "require-from-string": "^2.0.2",
+ "uri-js": "^4.2.2"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/epoberezkin"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "dependencies": {
+ "color-convert": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "node_modules/braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "dependencies": {
+ "fill-range": "^7.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/camel-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz",
+ "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==",
+ "dependencies": {
+ "pascal-case": "^3.1.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/capital-case": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz",
+ "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
+ "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
+ "dependencies": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/change-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz",
+ "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==",
+ "dependencies": {
+ "camel-case": "^4.1.2",
+ "capital-case": "^1.0.4",
+ "constant-case": "^3.0.4",
+ "dot-case": "^3.0.4",
+ "header-case": "^2.0.4",
+ "no-case": "^3.0.4",
+ "param-case": "^3.0.4",
+ "pascal-case": "^3.1.2",
+ "path-case": "^3.0.4",
+ "sentence-case": "^3.0.4",
+ "snake-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "dependencies": {
+ "color-name": "1.1.3"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+ },
+ "node_modules/constant-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz",
+ "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case": "^2.0.2"
+ }
+ },
+ "node_modules/data-uri-to-buffer": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz",
+ "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA==",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "dependencies": {
+ "path-type": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/dot-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz",
+ "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/escalade": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz",
+ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+ "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/fast-deep-equal": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
+ },
+ "node_modules/fast-glob": {
+ "version": "3.2.12",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz",
+ "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==",
+ "dependencies": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ },
+ "engines": {
+ "node": ">=8.6.0"
+ }
+ },
+ "node_modules/fastq": {
+ "version": "1.15.0",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
+ "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
+ "dependencies": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "node_modules/fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "paypal",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "dependencies": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ },
+ "engines": {
+ "node": "^12.20 || >= 14.13"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
+ "dependencies": {
+ "fetch-blob": "^3.1.2"
+ },
+ "engines": {
+ "node": ">=12.20.0"
+ }
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/globby": {
+ "version": "13.1.3",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.3.tgz",
+ "integrity": "sha512-8krCNHXvlCgHDpegPzleMq07yMYTO2sXKASmZmquEYWEmCx6J5UTRbp5RwMJkTJGtcQ44YpiUYUiN0b9mzy8Bw==",
+ "dependencies": {
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.11",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^4.0.0"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/has-flag": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+ "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/header-case": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz",
+ "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==",
+ "dependencies": {
+ "capital-case": "^1.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/ignore": {
+ "version": "5.2.4",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz",
+ "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
+ },
+ "node_modules/js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "dependencies": {
+ "argparse": "^2.0.1"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/json-schema-traverse": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
+ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
+ },
+ "node_modules/kleur": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/lower-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz",
+ "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.5",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+ "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "dependencies": {
+ "braces": "^3.0.2",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/mkdirp": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+ "bin": {
+ "mkdirp": "bin/cmd.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/mustache": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz",
+ "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==",
+ "bin": {
+ "mustache": "bin/mustache"
+ }
+ },
+ "node_modules/no-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz",
+ "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==",
+ "dependencies": {
+ "lower-case": "^2.0.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "github",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "engines": {
+ "node": ">=10.5.0"
+ }
+ },
+ "node_modules/node-fetch": {
+ "version": "3.2.8",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz",
+ "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==",
+ "dependencies": {
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/node-fetch"
+ }
+ },
+ "node_modules/node-watch": {
+ "version": "0.7.3",
+ "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz",
+ "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/param-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz",
+ "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/pascal-case": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz",
+ "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/path-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz",
+ "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/picocolors": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
+ "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ=="
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/prettier": {
+ "version": "2.8.2",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.2.tgz",
+ "integrity": "sha512-BtRV9BcncDyI2tsuS19zzhzoxD8Dh8LiCx7j7tHzrkz8GFXAexeWFdi22mjE1d16dftH2qNaytVxqiRTGlMfpw==",
+ "bin": {
+ "prettier": "bin-prettier.js"
+ },
+ "engines": {
+ "node": ">=10.13.0"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
+ }
+ },
+ "node_modules/prompts": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+ "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+ "dependencies": {
+ "kleur": "^3.0.3",
+ "sisteransi": "^1.0.5"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/punycode": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
+ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/require-from-string": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
+ "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==",
+ "engines": {
+ "iojs": ">=1.0.0",
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "node_modules/sentence-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz",
+ "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "node_modules/sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "node_modules/slash": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz",
+ "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/snake-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz",
+ "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/supports-color": {
+ "version": "5.5.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+ "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+ "dependencies": {
+ "has-flag": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.1.tgz",
+ "integrity": "sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA=="
+ },
+ "node_modules/upper-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz",
+ "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/upper-case-first": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz",
+ "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/uri-js": {
+ "version": "4.4.1",
+ "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
+ "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
+ "dependencies": {
+ "punycode": "^2.1.0"
+ }
+ },
+ "node_modules/vscode-jsonrpc": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.0.2.tgz",
+ "integrity": "sha512-RY7HwI/ydoC1Wwg4gJ3y6LpU9FJRZAUnTYMXthqhFXXu77ErDd/xkREpGuk4MyYkk4a+XDWAMqe0S3KkelYQEQ==",
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/vscode-languageserver": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-8.0.2.tgz",
+ "integrity": "sha512-bpEt2ggPxKzsAOZlXmCJ50bV7VrxwCS5BI4+egUmure/oI/t4OlFzi/YNtVvY24A2UDOZAgwFGgnZPwqSJubkA==",
+ "dependencies": {
+ "vscode-languageserver-protocol": "3.17.2"
+ },
+ "bin": {
+ "installServerIntoExtension": "bin/installServerIntoExtension"
+ }
+ },
+ "node_modules/vscode-languageserver-protocol": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.2.tgz",
+ "integrity": "sha512-8kYisQ3z/SQ2kyjlNeQxbkkTNmVFoQCqkmGrzLH6A9ecPlgTbp3wDTnUNqaUxYr4vlAcloxx8zwy7G5WdguYNg==",
+ "dependencies": {
+ "vscode-jsonrpc": "8.0.2",
+ "vscode-languageserver-types": "3.17.2"
+ }
+ },
+ "node_modules/vscode-languageserver-textdocument": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.8.tgz",
+ "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q=="
+ },
+ "node_modules/vscode-languageserver-types": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.2.tgz",
+ "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA=="
+ },
+ "node_modules/web-streams-polyfill": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz",
+ "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yargs": {
+ "version": "17.6.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz",
+ "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==",
+ "dependencies": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+ "engines": {
+ "node": ">=12"
+ }
+ }
+ },
+ "dependencies": {
+ "@azure-tools/cadl-apiview": {
+ "version": "0.3.3",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.3.tgz",
+ "integrity": "sha512-j16XUApC2C1HqRSbniJVhH0RUOeCHNE36kQt3TPI46CZQY8M6u/D8Gk3o+7MRQSBQ4QP8n9/h4h6AMAVPKVkew=="
+ },
+ "@azure-tools/cadl-autorest": {
+ "version": "0.24.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-autorest/-/cadl-autorest-0.24.0.tgz",
+ "integrity": "sha512-q8A3GRlwyQJ+/8cJs3dzyB4sRSVORItVS27NOraOwaXMudk9W6wW4uwBpyR07B3iHUanC8ZECe6CaCDUUttbtg==",
+ "requires": {}
+ },
+ "@azure-tools/cadl-azure-core": {
+ "version": "0.24.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-core/-/cadl-azure-core-0.24.0.tgz",
+ "integrity": "sha512-Pzs1uC03Rbd783dAN8yvsFEWKJIBpV7zKf+Mj2S2x7F9IsR+KS1nlPmifIAtSCeSRPVkU21xD1WmzXvB1GR59w==",
+ "requires": {
+ "@cadl-lang/lint": "~0.38.0"
+ }
+ },
+ "@babel/code-frame": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz",
+ "integrity": "sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==",
+ "requires": {
+ "@babel/highlight": "^7.18.6"
+ }
+ },
+ "@babel/helper-validator-identifier": {
+ "version": "7.19.1",
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz",
+ "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w=="
+ },
+ "@babel/highlight": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.18.6.tgz",
+ "integrity": "sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==",
+ "requires": {
+ "@babel/helper-validator-identifier": "^7.18.6",
+ "chalk": "^2.0.0",
+ "js-tokens": "^4.0.0"
+ }
+ },
+ "@cadl-lang/compiler": {
+ "version": "0.38.5",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/compiler/-/compiler-0.38.5.tgz",
+ "integrity": "sha512-jd6a8TEp9ApBzekTb39aBPocYrkuqzsQbLTDcc/c6tA47Wmr87463MAXpeB80ziEsr15sccI01j3g63jt5W0Aw==",
+ "requires": {
+ "@babel/code-frame": "~7.18.6",
+ "ajv": "~8.11.2",
+ "change-case": "~4.1.2",
+ "globby": "~13.1.1",
+ "js-yaml": "~4.1.0",
+ "mkdirp": "~1.0.4",
+ "mustache": "~4.2.0",
+ "node-fetch": "3.2.8",
+ "node-watch": "~0.7.1",
+ "picocolors": "~1.0.0",
+ "prettier": "~2.7.1",
+ "prompts": "~2.4.1",
+ "vscode-languageserver": "~8.0.2",
+ "vscode-languageserver-textdocument": "~1.0.1",
+ "yargs": "~17.6.2"
+ },
+ "dependencies": {
+ "prettier": {
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g=="
+ }
+ }
+ },
+ "@cadl-lang/lint": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/lint/-/lint-0.38.0.tgz",
+ "integrity": "sha512-6g4yoXeaNnTYxEWA0QywN3HkTCINPTHI56IsDKp6JhLOiROj1NvoufUzX438vdTqDqNyHg2t08fRmLMJP4GsCQ==",
+ "requires": {}
+ },
+ "@cadl-lang/openapi": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/openapi/-/openapi-0.38.0.tgz",
+ "integrity": "sha512-lFmU5AsZtw7Ofcnq3lg18Ieg21iuS73NOb+549BxPZX2j70vEqqfRT3CCCFmpGCK2sAUy2x2qD+pVUBcQIXeHQ==",
+ "peer": true,
+ "requires": {}
+ },
+ "@cadl-lang/prettier-plugin-cadl": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/prettier-plugin-cadl/-/prettier-plugin-cadl-0.38.0.tgz",
+ "integrity": "sha512-L4wXsTJukonB4KYEzPC/gpQcOXBGYHsBVgVa8D/Nc6tRRr2QLT+Oih7qpBTsuXgynWTP1EHr3iksbg3Mv91lnA==",
+ "requires": {
+ "prettier": "~2.7.1"
+ },
+ "dependencies": {
+ "prettier": {
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g=="
+ }
+ }
+ },
+ "@cadl-lang/rest": {
+ "version": "0.38.1",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/rest/-/rest-0.38.1.tgz",
+ "integrity": "sha512-bl+AKgX42+1B9bwDq1uORcAhEfkR0oKctMmbdqCZAhWmhWaKWm0JsnEyKQ1Ujfpw2La9DiVg5mgwsQqQ5jiTeA==",
+ "requires": {}
+ },
+ "@cadl-lang/versioning": {
+ "version": "0.38.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/versioning/-/versioning-0.38.0.tgz",
+ "integrity": "sha512-7ECvYQShLu80eyQzRgRH1Lu/P1lrjnHpnEcNZK8bVoHoy+QT+DkY/c22OoBRwcb5kux9/T1/CMF61WqfrKC8jQ==",
+ "requires": {
+ "@cadl-lang/compiler": "~0.38.0"
+ }
+ },
+ "@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "requires": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ }
+ },
+ "@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A=="
+ },
+ "@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "requires": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ }
+ },
+ "ajv": {
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-E4bfmKAhGiSTvMfL1Myyycaub+cUEU2/IvpylXkUu7CHBkBj1f/ikdzbD7YQ6FKUbixDxeYvB/xY4fvyroDlQg==",
+ "requires": {
+ "fast-deep-equal": "^3.1.1",
+ "json-schema-traverse": "^1.0.0",
+ "require-from-string": "^2.0.2",
+ "uri-js": "^4.2.2"
+ }
+ },
+ "ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="
+ },
+ "ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "requires": {
+ "color-convert": "^1.9.0"
+ }
+ },
+ "argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "requires": {
+ "fill-range": "^7.0.1"
+ }
+ },
+ "camel-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz",
+ "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==",
+ "requires": {
+ "pascal-case": "^3.1.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "capital-case": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz",
+ "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "chalk": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
+ "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
+ "requires": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ }
+ },
+ "change-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz",
+ "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==",
+ "requires": {
+ "camel-case": "^4.1.2",
+ "capital-case": "^1.0.4",
+ "constant-case": "^3.0.4",
+ "dot-case": "^3.0.4",
+ "header-case": "^2.0.4",
+ "no-case": "^3.0.4",
+ "param-case": "^3.0.4",
+ "pascal-case": "^3.1.2",
+ "path-case": "^3.0.4",
+ "sentence-case": "^3.0.4",
+ "snake-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "requires": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ }
+ },
+ "color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "requires": {
+ "color-name": "1.1.3"
+ }
+ },
+ "color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+ },
+ "constant-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz",
+ "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case": "^2.0.2"
+ }
+ },
+ "data-uri-to-buffer": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz",
+ "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA=="
+ },
+ "dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "requires": {
+ "path-type": "^4.0.0"
+ }
+ },
+ "dot-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz",
+ "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "escalade": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz",
+ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw=="
+ },
+ "escape-string-regexp": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+ "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg=="
+ },
+ "fast-deep-equal": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
+ },
+ "fast-glob": {
+ "version": "3.2.12",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz",
+ "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==",
+ "requires": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ }
+ },
+ "fastq": {
+ "version": "1.15.0",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
+ "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
+ "requires": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "requires": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ }
+ },
+ "fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "requires": {
+ "to-regex-range": "^5.0.1"
+ }
+ },
+ "formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
+ "requires": {
+ "fetch-blob": "^3.1.2"
+ }
+ },
+ "get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg=="
+ },
+ "glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "requires": {
+ "is-glob": "^4.0.1"
+ }
+ },
+ "globby": {
+ "version": "13.1.3",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.3.tgz",
+ "integrity": "sha512-8krCNHXvlCgHDpegPzleMq07yMYTO2sXKASmZmquEYWEmCx6J5UTRbp5RwMJkTJGtcQ44YpiUYUiN0b9mzy8Bw==",
+ "requires": {
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.11",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^4.0.0"
+ }
+ },
+ "has-flag": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+ "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw=="
+ },
+ "header-case": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz",
+ "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==",
+ "requires": {
+ "capital-case": "^1.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "ignore": {
+ "version": "5.2.4",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz",
+ "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ=="
+ },
+ "is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ=="
+ },
+ "is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg=="
+ },
+ "is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "requires": {
+ "is-extglob": "^2.1.1"
+ }
+ },
+ "is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="
+ },
+ "js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
+ },
+ "js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "requires": {
+ "argparse": "^2.0.1"
+ }
+ },
+ "json-schema-traverse": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
+ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
+ },
+ "kleur": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w=="
+ },
+ "lower-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz",
+ "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg=="
+ },
+ "micromatch": {
+ "version": "4.0.5",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+ "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "requires": {
+ "braces": "^3.0.2",
+ "picomatch": "^2.3.1"
+ }
+ },
+ "mkdirp": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="
+ },
+ "mustache": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz",
+ "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ=="
+ },
+ "no-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz",
+ "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==",
+ "requires": {
+ "lower-case": "^2.0.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ=="
+ },
+ "node-fetch": {
+ "version": "3.2.8",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz",
+ "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==",
+ "requires": {
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
+ }
+ },
+ "node-watch": {
+ "version": "0.7.3",
+ "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz",
+ "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ=="
+ },
+ "param-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz",
+ "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "pascal-case": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz",
+ "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "path-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz",
+ "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw=="
+ },
+ "picocolors": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
+ "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ=="
+ },
+ "picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA=="
+ },
+ "prettier": {
+ "version": "2.8.2",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.2.tgz",
+ "integrity": "sha512-BtRV9BcncDyI2tsuS19zzhzoxD8Dh8LiCx7j7tHzrkz8GFXAexeWFdi22mjE1d16dftH2qNaytVxqiRTGlMfpw=="
+ },
+ "prompts": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+ "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+ "requires": {
+ "kleur": "^3.0.3",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "punycode": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
+ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A=="
+ },
+ "queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="
+ },
+ "require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q=="
+ },
+ "require-from-string": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
+ "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="
+ },
+ "reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw=="
+ },
+ "run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "requires": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "sentence-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz",
+ "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "slash": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz",
+ "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew=="
+ },
+ "snake-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz",
+ "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "requires": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ }
+ },
+ "strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "requires": {
+ "ansi-regex": "^5.0.1"
+ }
+ },
+ "supports-color": {
+ "version": "5.5.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+ "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+ "requires": {
+ "has-flag": "^3.0.0"
+ }
+ },
+ "to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "requires": {
+ "is-number": "^7.0.0"
+ }
+ },
+ "tslib": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.1.tgz",
+ "integrity": "sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA=="
+ },
+ "upper-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz",
+ "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "upper-case-first": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz",
+ "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "uri-js": {
+ "version": "4.4.1",
+ "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
+ "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
+ "requires": {
+ "punycode": "^2.1.0"
+ }
+ },
+ "vscode-jsonrpc": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.0.2.tgz",
+ "integrity": "sha512-RY7HwI/ydoC1Wwg4gJ3y6LpU9FJRZAUnTYMXthqhFXXu77ErDd/xkREpGuk4MyYkk4a+XDWAMqe0S3KkelYQEQ=="
+ },
+ "vscode-languageserver": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-8.0.2.tgz",
+ "integrity": "sha512-bpEt2ggPxKzsAOZlXmCJ50bV7VrxwCS5BI4+egUmure/oI/t4OlFzi/YNtVvY24A2UDOZAgwFGgnZPwqSJubkA==",
+ "requires": {
+ "vscode-languageserver-protocol": "3.17.2"
+ }
+ },
+ "vscode-languageserver-protocol": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.2.tgz",
+ "integrity": "sha512-8kYisQ3z/SQ2kyjlNeQxbkkTNmVFoQCqkmGrzLH6A9ecPlgTbp3wDTnUNqaUxYr4vlAcloxx8zwy7G5WdguYNg==",
+ "requires": {
+ "vscode-jsonrpc": "8.0.2",
+ "vscode-languageserver-types": "3.17.2"
+ }
+ },
+ "vscode-languageserver-textdocument": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.8.tgz",
+ "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q=="
+ },
+ "vscode-languageserver-types": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.2.tgz",
+ "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA=="
+ },
+ "web-streams-polyfill": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz",
+ "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q=="
+ },
+ "wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "requires": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "dependencies": {
+ "ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "requires": {
+ "color-convert": "^2.0.1"
+ }
+ },
+ "color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "requires": {
+ "color-name": "~1.1.4"
+ }
+ },
+ "color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ }
+ }
+ },
+ "y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA=="
+ },
+ "yargs": {
+ "version": "17.6.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz",
+ "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==",
+ "requires": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ }
+ },
+ "yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw=="
+ }
+ }
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/package.json b/specification/cognitiveservices/OpenAI.Authoring/package.json
new file mode 100644
index 000000000000..4f7ed18b04ed
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "@cadl-api-spec/azure-openai-api-version-2022-06-01-preview",
+ "author": "Microsoft Corporation",
+ "description": "// FIXME: (miissing-service-description) Add service description",
+ "license": "MIT",
+ "dependencies": {
+ "@cadl-lang/compiler": "^0.38.0",
+ "@cadl-lang/rest": "^0.38.0",
+ "@cadl-lang/versioning": "^0.38.0",
+ "@cadl-lang/prettier-plugin-cadl": "^0.38",
+ "@azure-tools/cadl-azure-core": "^0.24.0",
+ "@azure-tools/cadl-autorest": "^0.24.0",
+ "@azure-tools/cadl-apiview": "~0.3.1",
+ "prettier": "^2.8.0"
+ },
+ "private": true
+}
diff --git a/specification/cognitiveservices/OpenAI.Authoring/serviceCustomizations.cadl b/specification/cognitiveservices/OpenAI.Authoring/serviceCustomizations.cadl
new file mode 100644
index 000000000000..811f7ff1a7cf
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/serviceCustomizations.cadl
@@ -0,0 +1,16 @@
+import "@azure-tools/cadl-azure-core";
+import "./common.cadl";
+
+namespace Azure.OpenAI.ServiceCustomizations;
+
+@friendlyName("{name}List", T)
+model OpenAiList {
+ @doc("Defines the type of this object")
+ object?: TType;
+ @doc("The list of {name}s", T)
+ data?: T[];
+}
+
+// TODO: enum value types not supported in csharp emitter, change TypeDiscriminator to TypeDiscriminatorKnownValues enum when fixed
+#suppress "@azure-tools/cadl-azure-core/documentation-required" "Internal template - no need for public documentation"
+op OpenAIListOperation is Azure.Core.Foundations.ResourceList>;
diff --git a/specification/cognitiveservices/OpenAI.Authoring/swagger-to-cadl.sh b/specification/cognitiveservices/OpenAI.Authoring/swagger-to-cadl.sh
new file mode 100644
index 000000000000..6b312842e7ce
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Authoring/swagger-to-cadl.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+autorest --reset
+autorest --require=README.md --cadl-init --use=https://aka.ms/autorest.cadl --output-folder="." --input-file="https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2022-06-01-preview/azureopenai.json"
\ No newline at end of file
diff --git a/specification/cognitiveservices/OpenAI.Inference/README.md b/specification/cognitiveservices/OpenAI.Inference/README.md
new file mode 100644
index 000000000000..9574868172d1
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/README.md
@@ -0,0 +1,5 @@
+title: AzureOpenAI
+clear-output-folder: false
+guessResourceKey: true
+isAzureSpec: true
+namespace: azure.openai.inference
\ No newline at end of file
diff --git a/specification/cognitiveservices/OpenAI.Inference/cadl-project.yaml b/specification/cognitiveservices/OpenAI.Inference/cadl-project.yaml
new file mode 100644
index 000000000000..390e405d6d9b
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/cadl-project.yaml
@@ -0,0 +1,19 @@
+emitters:
+ #"@azure-tools/cadl-autorest": true
+ "@azure-tools/cadl-apiview": true
+ # Uncomment this line and add "@azure-tools/cadl-python" to your package.json to generate Python code
+ # "@azure-tools/cadl-python":
+ # "basic-setup-py": true
+ # "package-version":
+ # "package-name":
+ # "output-path":
+ # Uncomment this line and add "@azure-tools/cadl-java" to your package.json to generate Java code
+ # "@azure-tools/cadl-java": true
+ # Uncomment this line and add "@azure-tools/cadl-csharp" to your package.json to generate C# code
+ "@azure-tools/cadl-csharp":
+ namespace: "Azure.AI.OpenAI"
+ clear-output-folder: true
+ generateConvenienceAPI: true
+ model-namespace: false
+ # Uncomment this line and add "@azure-tools/cadl-typescript" to your package.json to generate Typescript code
+ # "@azure-tools/cadl-typescript": true
diff --git a/specification/cognitiveservices/OpenAI.Inference/main.cadl b/specification/cognitiveservices/OpenAI.Inference/main.cadl
new file mode 100644
index 000000000000..743654b7fd40
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/main.cadl
@@ -0,0 +1,56 @@
+import "@cadl-lang/rest";
+import "@cadl-lang/versioning";
+
+import "./routes.cadl";
+
+using Cadl.Http;
+using Cadl.Rest;
+using Cadl.Versioning;
+
+@useAuth(
+ ApiKeyAuth |
+ OAuth2Auth<[{
+ type: OAuth2FlowType.implicit,
+ authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+ scopes: ["https://cognitiveservices.azure.com/.default"]
+ }]>)
+@service(
+ {
+ title: "Azure OpenAI API"
+ })
+@server(
+ "{endpoint}/openai",
+ "Azure OpenAI APIs for completions and search",
+ {
+ @doc("""
+Supported Cognitive Services endpoints (protocol and hostname, for example:
+https://westus.api.cognitive.microsoft.com).
+""")
+ endpoint: string,
+ }
+)
+@versioned(ServiceApiVersions)
+@versionedDependency(
+ [
+ [
+ ServiceApiVersions.v2022_12_01,
+ Azure.Core.Versions.v1_0_Preview_1
+ ]
+ ]
+)
+@doc("Azure OpenAI APIs for completions and search")
+namespace Azure.OpenAI;
+
+enum ServiceApiVersions {
+ v2022_12_01: "2022-12-01",
+}
+
+
+@doc("A specific deployment")
+@Cadl.Rest.resource("deployments")
+model Deployment {
+ @visibility("read")
+ @doc("deployment id of the deployed model")
+ @key
+ deploymentId: string;
+}
diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions.create.cadl b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.cadl
new file mode 100644
index 000000000000..fd602657dff8
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.cadl
@@ -0,0 +1,176 @@
+import "@cadl-lang/rest";
+
+using Cadl.Rest;
+using Cadl.Http;
+
+namespace Azure.OpenAI.Completions;
+
+@doc("Post body schema to create a prompt completion from a deployment")
+model CompletionsOptions {
+ @doc("""
+An optional prompt to complete from, encoded as a string, a list of strings, or
+a list of token lists. Defaults to <|endoftext|>. The prompt to complete from.
+If you would like to provide multiple prompts, use the POST variant of this
+method. Note that <|endoftext|> is the document separator that the model sees
+during training, so if a prompt is not specified the model will generate as if
+from the beginning of a new document. Maximum allowed size of string list is
+2048.
+""")
+ prompt?: string[];
+
+ @doc("The maximum number of tokens to generate. Has minimum of 0.")
+ max_tokens?: int32;
+
+ @doc("""
+What sampling temperature to use. Higher values means the model will take more
+risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones
+with a well-defined answer.
+We generally recommend using this or `top_p` but
+not both.
+Minimum of 0 and maximum of 2 allowed.
+
+""")
+ temperature?: float32;
+
+ @doc("""
+An alternative to sampling with temperature, called nucleus sampling, where the
+model considers the results of the tokens with top_p probability mass. So 0.1
+means only the tokens comprising the top 10% probability mass are
+considered.
+We generally recommend using this or `temperature` but not
+both.
+Minimum of 0 and maximum of 1 allowed.
+
+""")
+ top_p?: float32;
+
+ @doc("""
+Defaults to null. Modify the likelihood of specified tokens appearing in the
+completion. Accepts a json object that maps tokens (specified by their token ID
+in the GPT tokenizer) to an associated bias value from -100 to 100. You can use
+this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to
+token IDs. Mathematically, the bias is added to the logits generated by the
+model prior to sampling. The exact effect will vary per model, but values
+between -1 and 1 should decrease or increase likelihood of selection; values
+like -100 or 100 should result in a ban or exclusive selection of the relevant
+token. As an example, you can pass {\"50256\" : -100} to prevent the
+<|endoftext|> token from being generated.
+""")
+ logit_bias?: Record;
+
+ @doc("The ID of the end-user, for use in tracking and rate-limiting.")
+ user?: string;
+
+ @doc("""
+How many snippets to generate for each prompt. Minimum of 1 and maximum of 128
+allowed.
+""")
+ n?: int32;
+
+// stream mode requires some API update that we cannot generate nbow
+// @doc("""
+// Whether to enable streaming for this endpoint. If set, tokens will be sent as
+// server-sent events as they become available.
+// """)
+// stream?: boolean;
+
+ @doc("""
+Include the log probabilities on the `logprobs` most likely tokens, as well the
+chosen tokens. So for example, if `logprobs` is 10, the API will return a list
+of the 10 most likely tokens. If `logprobs` is 0, only the chosen tokens will
+have logprobs returned. Minimum of 0 and maximum of 100 allowed.
+""")
+ logprobs?: int32;
+
+ @doc("The name of the model to use")
+ "model"?: string;
+
+ @doc("Echo back the prompt in addition to the completion")
+ echo?: boolean;
+
+ @doc("A sequence which indicates the end of the current document.")
+ stop?: string[];
+
+ @doc("Completion configuration")
+ completion_config?: string;
+
+ @doc("""
+can be used to disable any server-side caching, 0=no cache, 1=prompt prefix
+enabled, 2=full cache
+""")
+ cache_level?: int32;
+
+ @doc("""
+How much to penalize new tokens based on their existing frequency in the text
+so far. Decreases the model's likelihood to repeat the same line verbatim. Has
+minimum of -2 and maximum of 2.
+""")
+ presence_penalty?: float32;
+
+ @doc("""
+How much to penalize new tokens based on whether they appear in the text so
+far. Increases the model's likelihood to talk about new topics.
+""")
+ frequency_penalty?: float32;
+
+ @doc("""
+How many generations to create server side, and display only the best. Will not
+stream intermediate progress if best_of > 1. Has maximum value of 128.
+""")
+ best_of?: int32;
+};
+
+@doc("Expected response schema to completion request")
+model Completions {
+ @doc("Request ID for troubleshooting purposes")
+ @header "apim-request-id": string;
+ @doc("Id for completion response")
+ id?: string;
+ @doc("Object for completion response")
+ object: "text_completion";
+ @doc("Created time for completion response")
+ created?: int32;
+ @doc("Model used for completion response")
+ "model"?: string;
+ @doc("Array of choices returned containing text completions to prompts sent")
+ choices?: Choice[];
+ @doc("Usage counts for tokens input using the completions API")
+ usage: CompletionsUsage;
+}
+
+@doc("Choice model within completion response")
+model Choice {
+ @doc("Generated text for given completion prompt")
+ text?: string;
+ @doc("Index")
+ index?: int32;
+ @doc("Log Prob Model")
+ logprobs?: CompletionsLogProbs;
+ @doc("Reason for finishing")
+ finish_reason?: string;
+}
+
+@doc("LogProbs model within completion choice")
+model CompletionsLogProbs {
+ @doc("Tokens")
+ tokens?: string[];
+ @doc("LogProbs of Tokens")
+ token_logprobs?: float32[];
+ @doc("Top LogProbs")
+ top_logprobs?: Record[];
+ @doc("Text offset")
+ text_offset?: int32[];
+}
+
+@doc("""
+Representation of the token counts processed for a completions request.
+Counts consider all tokens across prompts, choices, choice alternates, best_of generations, and other consumers.
+""")
+model CompletionsUsage {
+ @doc("Number of tokens received in the completion")
+ completion_tokens: int32,
+ @doc("Number of tokens sent in the original request")
+ prompt_tokens: int32,
+ @doc("Total number of tokens transacted in this request/response")
+ total_tokens: int32
+}
diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.cadl b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.cadl
new file mode 100644
index 000000000000..dce30efe6cf1
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.cadl
@@ -0,0 +1,63 @@
+import "@cadl-lang/rest";
+
+using Cadl.Rest;
+using Cadl.Http;
+
+namespace Azure.OpenAI.Embeddings;
+
+@doc("Schema to create a prompt completion from a deployment")
+model EmbeddingsOptions {
+ @doc("The ID of the end-user, for use in tracking and rate-limiting.")
+ user?: string;
+
+ @doc("input type of embedding search to use")
+ input_type?: string;
+
+ @doc("ID of the model to use")
+ "model"?: string;
+
+ @doc("""
+ Input text to get embeddings for, encoded as a string.
+ To get embeddings for multiple inputs in a single request, pass an array of strings.
+ Each input must not exceed 2048 tokens in length.
+
+ Unless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,
+ as we have observed inferior results when newlines are present.
+ """)
+ input: string | string[];
+};
+
+@doc("Expected response schema to embeddings request")
+model Embeddings {
+ @doc("Type of the data field")
+ object: "list",
+
+ @doc("Embedding values for the prompts submitted in the request")
+ data: EmbeddingItem[],
+
+ @doc("ID of the model to use")
+ "model"?: string;
+
+ @doc("Usage counts for tokens input using the embeddings API")
+ usage: EmbeddingsUsage;
+}
+
+@doc("Expected response schema to embeddings object list item request")
+model EmbeddingItem {
+ @doc("Name of the field in which the embedding is contained")
+ object: "embedding",
+
+ @doc("List of embeddings value for the input prompt. These represents a measurement of releated of text strings")
+ embedding: float32[];
+
+ @doc("Index of the prompt to which the EmbeddingItem corresponds")
+ index: int32;
+}
+
+@doc("Measurment of the amount of tokens used in this request and response")
+model EmbeddingsUsage {
+ @doc("Number of tokens sent in the original request")
+ prompt_tokens: int32,
+ @doc("Total number of tokens transacted in this request/response")
+ total_tokens: int32
+}
diff --git a/specification/cognitiveservices/OpenAI.Inference/package-lock.json b/specification/cognitiveservices/OpenAI.Inference/package-lock.json
new file mode 100644
index 000000000000..cc1c8acf59bb
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/package-lock.json
@@ -0,0 +1,5093 @@
+{
+ "name": "@cadl-api-spec/azure-openai-service-api",
+ "lockfileVersion": 2,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "@cadl-api-spec/azure-openai-service-api",
+ "license": "MIT",
+ "dependencies": {
+ "@azure-tools/cadl-apiview": "~0.3.1",
+ "@azure-tools/cadl-autorest": "^0.25.0",
+ "@azure-tools/cadl-azure-core": "^0.25.0",
+ "@azure-tools/cadl-csharp": "0.1.11-beta.20230201.2",
+ "@azure-tools/cadl-dpg": "0.25.0",
+ "@cadl-lang/compiler": "^0.39.0",
+ "@cadl-lang/prettier-plugin-cadl": "^0.39",
+ "@cadl-lang/rest": "^0.39.0",
+ "@cadl-lang/versioning": "^0.39.0",
+ "prettier": "^2.8.3"
+ }
+ },
+ "node_modules/@autorest/csharp": {
+ "version": "3.0.0-beta.20230201.2",
+ "resolved": "https://registry.npmjs.org/@autorest/csharp/-/csharp-3.0.0-beta.20230201.2.tgz",
+ "integrity": "sha512-fa1jLA1tLcS/MPnYdw7jiB/Jchdl0PvjLc4jpEm7VJxYCyWwevi6f5nOBYcOXRWp556bNqB7F0LZrspz+MJBEg=="
+ },
+ "node_modules/@azure-tools/cadl-apiview": {
+ "version": "0.3.1",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.1.tgz",
+ "integrity": "sha512-VtWb+FsxxLVDrtX7a0nVhXDoAOnsSd3BdXtyk0CSfaAKPOToZtd/H6H++peWNDrr/koaCfSMkRhCjbH5PVmgOQ==",
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-autorest": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-autorest/-/cadl-autorest-0.25.0.tgz",
+ "integrity": "sha512-4i4siT4uDVm64gCDcuzDT8xikC2XPCMp4k+NWwPBF2v39IUZkDTtvqSWqRKXhpEVRZcTKbTlJLamfzWGfvdBtg==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@azure-tools/cadl-azure-core": "~0.25.0",
+ "@cadl-lang/compiler": "~0.39.0",
+ "@cadl-lang/openapi": "~0.39.0",
+ "@cadl-lang/rest": "~0.39.0",
+ "@cadl-lang/versioning": "~0.39.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-azure-core": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-core/-/cadl-azure-core-0.25.0.tgz",
+ "integrity": "sha512-V3yhJ9mUKntAt2AVm4f/sR91H/wWD8CMLUPQm2GwgSe/Fkv9fc4qE6qnE4QUxPGYJUgYeDXYv12qRN2eLId9sA==",
+ "dependencies": {
+ "@cadl-lang/lint": "~0.39.0"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0",
+ "@cadl-lang/rest": "~0.39.0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-csharp": {
+ "version": "0.1.11-beta.20230201.2",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-csharp/-/cadl-csharp-0.1.11-beta.20230201.2.tgz",
+ "integrity": "sha512-JaCz/Ot5pS8yXlrOI5xHN4Dj3MSajVRBfY/OcBmx+pkHHROQ3ZagmK1y1xIBTJJWwniTAudHCsx4acFeUu9JKA==",
+ "dependencies": {
+ "@autorest/csharp": "3.0.0-beta.20230201.2",
+ "@azure-tools/cadl-autorest": "0.25.0",
+ "@azure-tools/cadl-azure-core": "0.25.0",
+ "@azure-tools/cadl-dpg": "0.25.0",
+ "@cadl-lang/compiler": "0.39.0",
+ "@cadl-lang/eslint-config-cadl": "0.5.0",
+ "@cadl-lang/eslint-plugin": "0.39.0",
+ "@cadl-lang/library-linter": "0.39.0",
+ "@cadl-lang/openapi": "0.39.0",
+ "@cadl-lang/rest": "0.39.0",
+ "@cadl-lang/versioning": "0.39.0",
+ "fs-extra": "^10.1.0",
+ "js-yaml": "^4.1.0",
+ "json-serialize-refs": "^0.1.0-0"
+ }
+ },
+ "node_modules/@azure-tools/cadl-dpg": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-dpg/-/cadl-dpg-0.25.0.tgz",
+ "integrity": "sha512-T4txhl86WH4se3gklRBNBmy81w7C1fY/fkuRLQGgycBqZ1BEOkn7UpExh90alrGs7eNT8YzWcgh9lO1HWn1BQA==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0",
+ "@cadl-lang/rest": "~0.39.0"
+ }
+ },
+ "node_modules/@babel/code-frame": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz",
+ "integrity": "sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==",
+ "dependencies": {
+ "@babel/highlight": "^7.18.6"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-validator-identifier": {
+ "version": "7.19.1",
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz",
+ "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/highlight": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.18.6.tgz",
+ "integrity": "sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==",
+ "dependencies": {
+ "@babel/helper-validator-identifier": "^7.18.6",
+ "chalk": "^2.0.0",
+ "js-tokens": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@cadl-lang/compiler": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/compiler/-/compiler-0.39.0.tgz",
+ "integrity": "sha512-eAEE66PrwmT4QlWjJm8H/YIljI9n7cNDnSIBN1mbfXFLORKauLhkmYfyVvFzCv/SWNJiw+7VwHje23ITJ/tFDA==",
+ "dependencies": {
+ "@babel/code-frame": "~7.18.6",
+ "ajv": "~8.11.2",
+ "change-case": "~4.1.2",
+ "globby": "~13.1.1",
+ "js-yaml": "~4.1.0",
+ "mkdirp": "~1.0.4",
+ "mustache": "~4.2.0",
+ "node-fetch": "3.2.8",
+ "node-watch": "~0.7.1",
+ "picocolors": "~1.0.0",
+ "prettier": "~2.8.1",
+ "prompts": "~2.4.1",
+ "vscode-languageserver": "~8.0.2",
+ "vscode-languageserver-textdocument": "~1.0.1",
+ "yargs": "~17.6.2"
+ },
+ "bin": {
+ "cadl": "cmd/cadl.js",
+ "cadl-server": "cmd/cadl-server.js"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@cadl-lang/eslint-config-cadl": {
+ "version": "0.5.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/eslint-config-cadl/-/eslint-config-cadl-0.5.0.tgz",
+ "integrity": "sha512-H8vM1K/8zyV7lQpT8XPf6VYMz52cil8DUVawdq3JkGrnunLC7woPhzr2Sl9uPg6e9vsiqRi9ZUmB51MIEaO1gA==",
+ "dependencies": {
+ "@rushstack/eslint-patch": "1.1.0 ",
+ "@typescript-eslint/eslint-plugin": "^5.30.7",
+ "@typescript-eslint/parser": "^5.30.7",
+ "eslint": "^8.12.0",
+ "eslint-config-prettier": "^8.5.0",
+ "eslint-plugin-mocha": "^10.0.5",
+ "eslint-plugin-prettier": "^4.0.0",
+ "eslint-plugin-unicorn": "^42.0.0",
+ "typescript": "~4.9.3"
+ }
+ },
+ "node_modules/@cadl-lang/eslint-plugin": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/eslint-plugin/-/eslint-plugin-0.39.0.tgz",
+ "integrity": "sha512-TbNbOuWiNABDzkPYQgZK+sa0740U6V9YRwsGn0pdUGHlFkbN/3rQkhyiiEPHfJkQXKrp2Y4gZLGRl0g7MkuDCA==",
+ "dependencies": {
+ "@typescript-eslint/utils": "~5.26.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ },
+ "peerDependencies": {
+ "eslint": ">=0.8.0"
+ }
+ },
+ "node_modules/@cadl-lang/library-linter": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/library-linter/-/library-linter-0.39.0.tgz",
+ "integrity": "sha512-omnr7kaF1iSXPlgMG0gQqne531gusjK+PBgAFuy6c4AIAlmDz/h5Xm1Jv95VEIUyAsbvlIhKl5bOZ5+DzzKoHw==",
+ "engines": {
+ "node": ">=14.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0"
+ }
+ },
+ "node_modules/@cadl-lang/lint": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/lint/-/lint-0.39.0.tgz",
+ "integrity": "sha512-qaWnOYH68ppEDI4jWhPMk6gUIs7t/VYREAjvjniwjc5IYhHPFz5hzFUjmZOAp1az9bxJVwBVtGp1pSB8LFgXCQ==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0"
+ }
+ },
+ "node_modules/@cadl-lang/openapi": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/openapi/-/openapi-0.39.0.tgz",
+ "integrity": "sha512-N/NlryVdaFKzzSdbLeko09M5s2aNEnZsMXHYCMCb9b0HLeJJ/cR/nCulTxCoNO1VMN5VWdSaohBtle4EHS/HSw==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0",
+ "@cadl-lang/rest": "~0.39.0"
+ }
+ },
+ "node_modules/@cadl-lang/prettier-plugin-cadl": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/prettier-plugin-cadl/-/prettier-plugin-cadl-0.39.0.tgz",
+ "integrity": "sha512-oBr0qYKdVgfTwAv8Db2UcQUbGJTDq1Na/6CkhVWOsPb1k9Rm2ByEDNEKURF7WgC6+YI0A1x2KIECAJDbdrHS7g==",
+ "dependencies": {
+ "prettier": "~2.8.1"
+ }
+ },
+ "node_modules/@cadl-lang/rest": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/rest/-/rest-0.39.0.tgz",
+ "integrity": "sha512-KpEpC/kEoeEFT4DpuG6G4kK2kzuQ4sH85P99ched8CLAo2SzWT0WVYEjya1ony+hqKlvm2nrigattX7P1ES8TQ==",
+ "engines": {
+ "node": ">=16.0.0"
+ },
+ "peerDependencies": {
+ "@cadl-lang/compiler": "~0.39.0"
+ }
+ },
+ "node_modules/@cadl-lang/versioning": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/versioning/-/versioning-0.39.0.tgz",
+ "integrity": "sha512-mMmqHTo/Cwssb5Y1qC5Fb4rPkyt7JPK+bWT8KH/oprdG3MOJSemyeEIxQtkId3oBdHZiQHG7T9IN80Dks3GE/A==",
+ "dependencies": {
+ "@cadl-lang/compiler": "~0.39.0"
+ },
+ "engines": {
+ "node": ">=16.0.0"
+ }
+ },
+ "node_modules/@eslint/eslintrc": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.1.tgz",
+ "integrity": "sha512-XXrH9Uarn0stsyldqDYq8r++mROmWRI1xKMXa640Bb//SY1+ECYX6VzT6Lcx5frD0V30XieqJ0oX9I2Xj5aoMA==",
+ "dependencies": {
+ "ajv": "^6.12.4",
+ "debug": "^4.3.2",
+ "espree": "^9.4.0",
+ "globals": "^13.19.0",
+ "ignore": "^5.2.0",
+ "import-fresh": "^3.2.1",
+ "js-yaml": "^4.1.0",
+ "minimatch": "^3.1.2",
+ "strip-json-comments": "^3.1.1"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/eslint"
+ }
+ },
+ "node_modules/@eslint/eslintrc/node_modules/ajv": {
+ "version": "6.12.6",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
+ "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.1",
+ "fast-json-stable-stringify": "^2.0.0",
+ "json-schema-traverse": "^0.4.1",
+ "uri-js": "^4.2.2"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/epoberezkin"
+ }
+ },
+ "node_modules/@eslint/eslintrc/node_modules/json-schema-traverse": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
+ "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
+ },
+ "node_modules/@humanwhocodes/config-array": {
+ "version": "0.11.8",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.8.tgz",
+ "integrity": "sha512-UybHIJzJnR5Qc/MsD9Kr+RpO2h+/P1GhOwdiLPXK5TWk5sgTdu88bTD9UP+CKbPPh5Rni1u0GjAdYQLemG8g+g==",
+ "dependencies": {
+ "@humanwhocodes/object-schema": "^1.2.1",
+ "debug": "^4.1.1",
+ "minimatch": "^3.0.5"
+ },
+ "engines": {
+ "node": ">=10.10.0"
+ }
+ },
+ "node_modules/@humanwhocodes/module-importer": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz",
+ "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==",
+ "engines": {
+ "node": ">=12.22"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/nzakas"
+ }
+ },
+ "node_modules/@humanwhocodes/object-schema": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz",
+ "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA=="
+ },
+ "node_modules/@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "dependencies": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "dependencies": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@rushstack/eslint-patch": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.0.tgz",
+ "integrity": "sha512-JLo+Y592QzIE+q7Dl2pMUtt4q8SKYI5jDrZxrozEQxnGVOyYE+GWK9eLkwTaeN9DDctlaRAQ3TBmzZ1qdLE30A=="
+ },
+ "node_modules/@types/json-schema": {
+ "version": "7.0.11",
+ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz",
+ "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ=="
+ },
+ "node_modules/@types/normalize-package-data": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.1.tgz",
+ "integrity": "sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw=="
+ },
+ "node_modules/@types/semver": {
+ "version": "7.3.13",
+ "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.3.13.tgz",
+ "integrity": "sha512-21cFJr9z3g5dW8B0CVI9g2O9beqaThGQ6ZFBqHfwhzLDKUxaqTIy3vnfah/UPkfOiF2pLq+tGz+W8RyCskuslw=="
+ },
+ "node_modules/@typescript-eslint/eslint-plugin": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.48.2.tgz",
+ "integrity": "sha512-sR0Gja9Ky1teIq4qJOl0nC+Tk64/uYdX+mi+5iB//MH8gwyx8e3SOyhEzeLZEFEEfCaLf8KJq+Bd/6je1t+CAg==",
+ "dependencies": {
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/type-utils": "5.48.2",
+ "@typescript-eslint/utils": "5.48.2",
+ "debug": "^4.3.4",
+ "ignore": "^5.2.0",
+ "natural-compare-lite": "^1.4.0",
+ "regexpp": "^3.2.0",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "@typescript-eslint/parser": "^5.0.0",
+ "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ },
+ "peerDependenciesMeta": {
+ "typescript": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@typescript-eslint/eslint-plugin/node_modules/@typescript-eslint/utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.2.tgz",
+ "integrity": "sha512-2h18c0d7jgkw6tdKTlNaM7wyopbLRBiit8oAxoP89YnuBOzCZ8g8aBCaCqq7h208qUTroL7Whgzam7UY3HVLow==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.9",
+ "@types/semver": "^7.3.12",
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0",
+ "semver": "^7.3.7"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ }
+ },
+ "node_modules/@typescript-eslint/parser": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.48.2.tgz",
+ "integrity": "sha512-38zMsKsG2sIuM5Oi/olurGwYJXzmtdsHhn5mI/pQogP+BjYVkK5iRazCQ8RGS0V+YLk282uWElN70zAAUmaYHw==",
+ "dependencies": {
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "debug": "^4.3.4"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ },
+ "peerDependenciesMeta": {
+ "typescript": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@typescript-eslint/scope-manager": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.48.2.tgz",
+ "integrity": "sha512-zEUFfonQid5KRDKoI3O+uP1GnrFd4tIHlvs+sTJXiWuypUWMuDaottkJuR612wQfOkjYbsaskSIURV9xo4f+Fw==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/visitor-keys": "5.48.2"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/@typescript-eslint/type-utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.48.2.tgz",
+ "integrity": "sha512-QVWx7J5sPMRiOMJp5dYshPxABRoZV1xbRirqSk8yuIIsu0nvMTZesKErEA3Oix1k+uvsk8Cs8TGJ6kQ0ndAcew==",
+ "dependencies": {
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "@typescript-eslint/utils": "5.48.2",
+ "debug": "^4.3.4",
+ "tsutils": "^3.21.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "eslint": "*"
+ },
+ "peerDependenciesMeta": {
+ "typescript": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@typescript-eslint/type-utils/node_modules/@typescript-eslint/utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.2.tgz",
+ "integrity": "sha512-2h18c0d7jgkw6tdKTlNaM7wyopbLRBiit8oAxoP89YnuBOzCZ8g8aBCaCqq7h208qUTroL7Whgzam7UY3HVLow==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.9",
+ "@types/semver": "^7.3.12",
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0",
+ "semver": "^7.3.7"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ }
+ },
+ "node_modules/@typescript-eslint/types": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.48.2.tgz",
+ "integrity": "sha512-hE7dA77xxu7ByBc6KCzikgfRyBCTst6dZQpwaTy25iMYOnbNljDT4hjhrGEJJ0QoMjrfqrx+j1l1B9/LtKeuqA==",
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/@typescript-eslint/typescript-estree": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.48.2.tgz",
+ "integrity": "sha512-bibvD3z6ilnoVxUBFEgkO0k0aFvUc4Cttt0dAreEr+nrAHhWzkO83PEVVuieK3DqcgL6VAK5dkzK8XUVja5Zcg==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/visitor-keys": "5.48.2",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-glob": "^4.0.3",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependenciesMeta": {
+ "typescript": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@typescript-eslint/typescript-estree/node_modules/globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "dependencies": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/@typescript-eslint/typescript-estree/node_modules/slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@typescript-eslint/utils": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.26.0.tgz",
+ "integrity": "sha512-PJFwcTq2Pt4AMOKfe3zQOdez6InIDOjUJJD3v3LyEtxHGVVRK3Vo7Dd923t/4M9hSH2q2CLvcTdxlLPjcIk3eg==",
+ "dependencies": {
+ "@types/json-schema": "^7.0.9",
+ "@typescript-eslint/scope-manager": "5.26.0",
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/typescript-estree": "5.26.0",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependencies": {
+ "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/scope-manager": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.26.0.tgz",
+ "integrity": "sha512-gVzTJUESuTwiju/7NiTb4c5oqod8xt5GhMbExKsCTp6adU3mya6AGJ4Pl9xC7x2DX9UYFsjImC0mA62BCY22Iw==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/visitor-keys": "5.26.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/types": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.26.0.tgz",
+ "integrity": "sha512-8794JZFE1RN4XaExLWLI2oSXsVImNkl79PzTOOWt9h0UHROwJedNOD2IJyfL0NbddFllcktGIO2aOu10avQQyA==",
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/typescript-estree": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.26.0.tgz",
+ "integrity": "sha512-EyGpw6eQDsfD6jIqmXP3rU5oHScZ51tL/cZgFbFBvWuCwrIptl+oueUZzSmLtxFuSOQ9vDcJIs+279gnJkfd1w==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/visitor-keys": "5.26.0",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-glob": "^4.0.3",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ },
+ "peerDependenciesMeta": {
+ "typescript": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/@typescript-eslint/visitor-keys": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.26.0.tgz",
+ "integrity": "sha512-wei+ffqHanYDOQgg/fS6Hcar6wAWv0CUPQ3TZzOWd2BLfgP539rb49bwua8WRAs7R6kOSLn82rfEu2ro6Llt8Q==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.26.0",
+ "eslint-visitor-keys": "^3.3.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "dependencies": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/@typescript-eslint/utils/node_modules/slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@typescript-eslint/visitor-keys": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.48.2.tgz",
+ "integrity": "sha512-z9njZLSkwmjFWUelGEwEbdf4NwKvfHxvGC0OcGN1Hp/XNDIcJ7D5DpPNPv6x6/mFvc1tQHsaWmpD/a4gOvvCJQ==",
+ "dependencies": {
+ "@typescript-eslint/types": "5.48.2",
+ "eslint-visitor-keys": "^3.3.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/typescript-eslint"
+ }
+ },
+ "node_modules/acorn": {
+ "version": "8.8.1",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.1.tgz",
+ "integrity": "sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA==",
+ "bin": {
+ "acorn": "bin/acorn"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/acorn-jsx": {
+ "version": "5.3.2",
+ "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz",
+ "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==",
+ "peerDependencies": {
+ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0"
+ }
+ },
+ "node_modules/ajv": {
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-E4bfmKAhGiSTvMfL1Myyycaub+cUEU2/IvpylXkUu7CHBkBj1f/ikdzbD7YQ6FKUbixDxeYvB/xY4fvyroDlQg==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.1",
+ "json-schema-traverse": "^1.0.0",
+ "require-from-string": "^2.0.2",
+ "uri-js": "^4.2.2"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/epoberezkin"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "dependencies": {
+ "color-convert": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "node_modules/array-union": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz",
+ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/balanced-match": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
+ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
+ },
+ "node_modules/brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "dependencies": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "node_modules/braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "dependencies": {
+ "fill-range": "^7.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/builtin-modules": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz",
+ "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==",
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/callsites": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz",
+ "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/camel-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz",
+ "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==",
+ "dependencies": {
+ "pascal-case": "^3.1.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/capital-case": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz",
+ "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "node_modules/chalk": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
+ "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
+ "dependencies": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/change-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz",
+ "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==",
+ "dependencies": {
+ "camel-case": "^4.1.2",
+ "capital-case": "^1.0.4",
+ "constant-case": "^3.0.4",
+ "dot-case": "^3.0.4",
+ "header-case": "^2.0.4",
+ "no-case": "^3.0.4",
+ "param-case": "^3.0.4",
+ "pascal-case": "^3.1.2",
+ "path-case": "^3.0.4",
+ "sentence-case": "^3.0.4",
+ "snake-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/ci-info": {
+ "version": "3.7.1",
+ "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.7.1.tgz",
+ "integrity": "sha512-4jYS4MOAaCIStSRwiuxc4B8MYhIe676yO1sYGzARnjXkWpmzZMMYxY6zu8WYWDhSuth5zhrQ1rhNSibyyvv4/w==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/sibiraj-s"
+ }
+ ],
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/clean-regexp": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/clean-regexp/-/clean-regexp-1.0.0.tgz",
+ "integrity": "sha512-GfisEZEJvzKrmGWkvfhgzcz/BllN1USeqD2V6tg14OAOgaCD2Z/PUEuxnAZ/nPvmaHRG7a8y77p1T/IRQ4D1Hw==",
+ "dependencies": {
+ "escape-string-regexp": "^1.0.5"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "dependencies": {
+ "color-name": "1.1.3"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+ },
+ "node_modules/concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
+ },
+ "node_modules/constant-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz",
+ "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case": "^2.0.2"
+ }
+ },
+ "node_modules/cross-spawn": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
+ "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+ "dependencies": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/data-uri-to-buffer": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz",
+ "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA==",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.3.4",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
+ "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==",
+ "dependencies": {
+ "ms": "2.1.2"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/deep-is": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
+ "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="
+ },
+ "node_modules/dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "dependencies": {
+ "path-type": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/doctrine": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz",
+ "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==",
+ "dependencies": {
+ "esutils": "^2.0.2"
+ },
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/dot-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz",
+ "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/error-ex": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz",
+ "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==",
+ "dependencies": {
+ "is-arrayish": "^0.2.1"
+ }
+ },
+ "node_modules/escalade": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz",
+ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+ "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/eslint": {
+ "version": "8.32.0",
+ "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.32.0.tgz",
+ "integrity": "sha512-nETVXpnthqKPFyuY2FNjz/bEd6nbosRgKbkgS/y1C7LJop96gYHWpiguLecMHQ2XCPxn77DS0P+68WzG6vkZSQ==",
+ "dependencies": {
+ "@eslint/eslintrc": "^1.4.1",
+ "@humanwhocodes/config-array": "^0.11.8",
+ "@humanwhocodes/module-importer": "^1.0.1",
+ "@nodelib/fs.walk": "^1.2.8",
+ "ajv": "^6.10.0",
+ "chalk": "^4.0.0",
+ "cross-spawn": "^7.0.2",
+ "debug": "^4.3.2",
+ "doctrine": "^3.0.0",
+ "escape-string-regexp": "^4.0.0",
+ "eslint-scope": "^7.1.1",
+ "eslint-utils": "^3.0.0",
+ "eslint-visitor-keys": "^3.3.0",
+ "espree": "^9.4.0",
+ "esquery": "^1.4.0",
+ "esutils": "^2.0.2",
+ "fast-deep-equal": "^3.1.3",
+ "file-entry-cache": "^6.0.1",
+ "find-up": "^5.0.0",
+ "glob-parent": "^6.0.2",
+ "globals": "^13.19.0",
+ "grapheme-splitter": "^1.0.4",
+ "ignore": "^5.2.0",
+ "import-fresh": "^3.0.0",
+ "imurmurhash": "^0.1.4",
+ "is-glob": "^4.0.0",
+ "is-path-inside": "^3.0.3",
+ "js-sdsl": "^4.1.4",
+ "js-yaml": "^4.1.0",
+ "json-stable-stringify-without-jsonify": "^1.0.1",
+ "levn": "^0.4.1",
+ "lodash.merge": "^4.6.2",
+ "minimatch": "^3.1.2",
+ "natural-compare": "^1.4.0",
+ "optionator": "^0.9.1",
+ "regexpp": "^3.2.0",
+ "strip-ansi": "^6.0.1",
+ "strip-json-comments": "^3.1.0",
+ "text-table": "^0.2.0"
+ },
+ "bin": {
+ "eslint": "bin/eslint.js"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/eslint"
+ }
+ },
+ "node_modules/eslint-config-prettier": {
+ "version": "8.6.0",
+ "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-8.6.0.tgz",
+ "integrity": "sha512-bAF0eLpLVqP5oEVUFKpMA+NnRFICwn9X8B5jrR9FcqnYBuPbqWEjTEspPWMj5ye6czoSLDweCzSo3Ko7gGrZaA==",
+ "bin": {
+ "eslint-config-prettier": "bin/cli.js"
+ },
+ "peerDependencies": {
+ "eslint": ">=7.0.0"
+ }
+ },
+ "node_modules/eslint-plugin-mocha": {
+ "version": "10.1.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-mocha/-/eslint-plugin-mocha-10.1.0.tgz",
+ "integrity": "sha512-xLqqWUF17llsogVOC+8C6/jvQ+4IoOREbN7ZCHuOHuD6cT5cDD4h7f2LgsZuzMAiwswWE21tO7ExaknHVDrSkw==",
+ "dependencies": {
+ "eslint-utils": "^3.0.0",
+ "rambda": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=14.0.0"
+ },
+ "peerDependencies": {
+ "eslint": ">=7.0.0"
+ }
+ },
+ "node_modules/eslint-plugin-prettier": {
+ "version": "4.2.1",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-4.2.1.tgz",
+ "integrity": "sha512-f/0rXLXUt0oFYs8ra4w49wYZBG5GKZpAYsJSm6rnYL5uVDjd+zowwMwVZHnAjf4edNrKpCDYfXDgmRE/Ak7QyQ==",
+ "dependencies": {
+ "prettier-linter-helpers": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ },
+ "peerDependencies": {
+ "eslint": ">=7.28.0",
+ "prettier": ">=2.0.0"
+ },
+ "peerDependenciesMeta": {
+ "eslint-config-prettier": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/eslint-plugin-unicorn": {
+ "version": "42.0.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-42.0.0.tgz",
+ "integrity": "sha512-ixBsbhgWuxVaNlPTT8AyfJMlhyC5flCJFjyK3oKE8TRrwBnaHvUbuIkCM1lqg8ryYrFStL/T557zfKzX4GKSlg==",
+ "dependencies": {
+ "@babel/helper-validator-identifier": "^7.15.7",
+ "ci-info": "^3.3.0",
+ "clean-regexp": "^1.0.0",
+ "eslint-utils": "^3.0.0",
+ "esquery": "^1.4.0",
+ "indent-string": "^4.0.0",
+ "is-builtin-module": "^3.1.0",
+ "lodash": "^4.17.21",
+ "pluralize": "^8.0.0",
+ "read-pkg-up": "^7.0.1",
+ "regexp-tree": "^0.1.24",
+ "safe-regex": "^2.1.1",
+ "semver": "^7.3.5",
+ "strip-indent": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sindresorhus/eslint-plugin-unicorn?sponsor=1"
+ },
+ "peerDependencies": {
+ "eslint": ">=8.8.0"
+ }
+ },
+ "node_modules/eslint-scope": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz",
+ "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==",
+ "dependencies": {
+ "esrecurse": "^4.3.0",
+ "estraverse": "^4.1.1"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/eslint-utils": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz",
+ "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==",
+ "dependencies": {
+ "eslint-visitor-keys": "^2.0.0"
+ },
+ "engines": {
+ "node": "^10.0.0 || ^12.0.0 || >= 14.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/mysticatea"
+ },
+ "peerDependencies": {
+ "eslint": ">=5"
+ }
+ },
+ "node_modules/eslint-utils/node_modules/eslint-visitor-keys": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz",
+ "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/eslint-visitor-keys": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.3.0.tgz",
+ "integrity": "sha512-mQ+suqKJVyeuwGYHAdjMFqjCyfl8+Ldnxuyp3ldiMBFKkvytrXUZWaiPCEav8qDHKty44bD+qV1IP4T+w+xXRA==",
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ }
+ },
+ "node_modules/eslint/node_modules/ajv": {
+ "version": "6.12.6",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
+ "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
+ "dependencies": {
+ "fast-deep-equal": "^3.1.1",
+ "fast-json-stable-stringify": "^2.0.0",
+ "json-schema-traverse": "^0.4.1",
+ "uri-js": "^4.2.2"
+ },
+ "funding": {
+ "type": "github",
+ "url": "https://github.com/sponsors/epoberezkin"
+ }
+ },
+ "node_modules/eslint/node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/eslint/node_modules/chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/eslint/node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/eslint/node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/eslint/node_modules/escape-string-regexp": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+ "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/eslint/node_modules/eslint-scope": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.1.1.tgz",
+ "integrity": "sha512-QKQM/UXpIiHcLqJ5AOyIW7XZmzjkzQXYE54n1++wb0u9V/abW3l9uQnxX8Z5Xd18xyKIMTUAyQ0k1e8pz6LUrw==",
+ "dependencies": {
+ "esrecurse": "^4.3.0",
+ "estraverse": "^5.2.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ }
+ },
+ "node_modules/eslint/node_modules/estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/eslint/node_modules/glob-parent": {
+ "version": "6.0.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz",
+ "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==",
+ "dependencies": {
+ "is-glob": "^4.0.3"
+ },
+ "engines": {
+ "node": ">=10.13.0"
+ }
+ },
+ "node_modules/eslint/node_modules/has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/eslint/node_modules/json-schema-traverse": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
+ "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
+ },
+ "node_modules/eslint/node_modules/supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/espree": {
+ "version": "9.4.1",
+ "resolved": "https://registry.npmjs.org/espree/-/espree-9.4.1.tgz",
+ "integrity": "sha512-XwctdmTO6SIvCzd9810yyNzIrOrqNYV9Koizx4C/mRhf9uq0o4yHoCEU/670pOxOL/MSraektvSAji79kX90Vg==",
+ "dependencies": {
+ "acorn": "^8.8.0",
+ "acorn-jsx": "^5.3.2",
+ "eslint-visitor-keys": "^3.3.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/eslint"
+ }
+ },
+ "node_modules/esquery": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz",
+ "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==",
+ "dependencies": {
+ "estraverse": "^5.1.0"
+ },
+ "engines": {
+ "node": ">=0.10"
+ }
+ },
+ "node_modules/esquery/node_modules/estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esrecurse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz",
+ "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==",
+ "dependencies": {
+ "estraverse": "^5.2.0"
+ },
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esrecurse/node_modules/estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/estraverse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz",
+ "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esutils": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
+ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/fast-deep-equal": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
+ },
+ "node_modules/fast-diff": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.2.0.tgz",
+ "integrity": "sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w=="
+ },
+ "node_modules/fast-glob": {
+ "version": "3.2.12",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz",
+ "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==",
+ "dependencies": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ },
+ "engines": {
+ "node": ">=8.6.0"
+ }
+ },
+ "node_modules/fast-json-stable-stringify": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz",
+ "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw=="
+ },
+ "node_modules/fast-levenshtein": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
+ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="
+ },
+ "node_modules/fastq": {
+ "version": "1.14.0",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.14.0.tgz",
+ "integrity": "sha512-eR2D+V9/ExcbF9ls441yIuN6TI2ED1Y2ZcA5BmMtJsOkWOFRJQ0Jt0g1UwqXJJVAb+V+umH5Dfr8oh4EVP7VVg==",
+ "dependencies": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "node_modules/fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "paypal",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "dependencies": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ },
+ "engines": {
+ "node": "^12.20 || >= 14.13"
+ }
+ },
+ "node_modules/file-entry-cache": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz",
+ "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==",
+ "dependencies": {
+ "flat-cache": "^3.0.4"
+ },
+ "engines": {
+ "node": "^10.12.0 || >=12.0.0"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/find-up": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz",
+ "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==",
+ "dependencies": {
+ "locate-path": "^6.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/flat-cache": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz",
+ "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==",
+ "dependencies": {
+ "flatted": "^3.1.0",
+ "rimraf": "^3.0.2"
+ },
+ "engines": {
+ "node": "^10.12.0 || >=12.0.0"
+ }
+ },
+ "node_modules/flatted": {
+ "version": "3.2.7",
+ "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.7.tgz",
+ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ=="
+ },
+ "node_modules/formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
+ "dependencies": {
+ "fetch-blob": "^3.1.2"
+ },
+ "engines": {
+ "node": ">=12.20.0"
+ }
+ },
+ "node_modules/fs-extra": {
+ "version": "10.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz",
+ "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==",
+ "dependencies": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/fs.realpath": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+ "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
+ },
+ "node_modules/function-bind": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",
+ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A=="
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/glob": {
+ "version": "7.2.3",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
+ "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
+ "dependencies": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.1.1",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ },
+ "engines": {
+ "node": "*"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/globals": {
+ "version": "13.19.0",
+ "resolved": "https://registry.npmjs.org/globals/-/globals-13.19.0.tgz",
+ "integrity": "sha512-dkQ957uSRWHw7CFXLUtUHQI3g3aWApYhfNR2O6jn/907riyTYKVBmxYVROkBcY614FSSeSJh7Xm7SrUWCxvJMQ==",
+ "dependencies": {
+ "type-fest": "^0.20.2"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/globby": {
+ "version": "13.1.2",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.2.tgz",
+ "integrity": "sha512-LKSDZXToac40u8Q1PQtZihbNdTYSNMuWe+K5l+oa6KgDzSvVrHXlJy40hUP522RjAIoNLJYBJi7ow+rbFpIhHQ==",
+ "dependencies": {
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.11",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^4.0.0"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/graceful-fs": {
+ "version": "4.2.10",
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz",
+ "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA=="
+ },
+ "node_modules/grapheme-splitter": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/grapheme-splitter/-/grapheme-splitter-1.0.4.tgz",
+ "integrity": "sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ=="
+ },
+ "node_modules/has": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
+ "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==",
+ "dependencies": {
+ "function-bind": "^1.1.1"
+ },
+ "engines": {
+ "node": ">= 0.4.0"
+ }
+ },
+ "node_modules/has-flag": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+ "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/header-case": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz",
+ "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==",
+ "dependencies": {
+ "capital-case": "^1.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/hosted-git-info": {
+ "version": "2.8.9",
+ "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz",
+ "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw=="
+ },
+ "node_modules/ignore": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.1.tgz",
+ "integrity": "sha512-d2qQLzTJ9WxQftPAuEQpSPmKqzxePjzVbpAVv62AQ64NTL+wR4JkrVqR/LqFsFEUsHDAiId52mJteHDFuDkElA==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/import-fresh": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz",
+ "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==",
+ "dependencies": {
+ "parent-module": "^1.0.0",
+ "resolve-from": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/imurmurhash": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz",
+ "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==",
+ "engines": {
+ "node": ">=0.8.19"
+ }
+ },
+ "node_modules/indent-string": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
+ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/inflight": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
+ "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
+ "dependencies": {
+ "once": "^1.3.0",
+ "wrappy": "1"
+ }
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "node_modules/is-arrayish": {
+ "version": "0.2.1",
+ "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz",
+ "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg=="
+ },
+ "node_modules/is-builtin-module": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.0.tgz",
+ "integrity": "sha512-phDA4oSGt7vl1n5tJvTWooWWAsXLY+2xCnxNqvKhGEzujg+A43wPlPOyDg3C8XQHN+6k/JTQWJ/j0dQh/qr+Hw==",
+ "dependencies": {
+ "builtin-modules": "^3.3.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-core-module": {
+ "version": "2.11.0",
+ "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.11.0.tgz",
+ "integrity": "sha512-RRjxlvLDkD1YJwDbroBHMb+cukurkDWNyHx7D3oNB5x9rb5ogcksMC5wHCadcXoo67gVr/+3GFySh3134zi6rw==",
+ "dependencies": {
+ "has": "^1.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-path-inside": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz",
+ "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
+ },
+ "node_modules/js-sdsl": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/js-sdsl/-/js-sdsl-4.2.0.tgz",
+ "integrity": "sha512-dyBIzQBDkCqCu+0upx25Y2jGdbTGxE9fshMsCdK0ViOongpV+n5tXRcZY9v7CaVQ79AGS9KA1KHtojxiM7aXSQ==",
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/js-sdsl"
+ }
+ },
+ "node_modules/js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
+ },
+ "node_modules/js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "dependencies": {
+ "argparse": "^2.0.1"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/json-parse-even-better-errors": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz",
+ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="
+ },
+ "node_modules/json-schema-traverse": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
+ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
+ },
+ "node_modules/json-serialize-refs": {
+ "version": "0.1.0-0",
+ "resolved": "https://registry.npmjs.org/json-serialize-refs/-/json-serialize-refs-0.1.0-0.tgz",
+ "integrity": "sha512-SnNMfW2RRPDXIMKa8zdLb59UjMSI1UFZCtIb8ae68GcZ0a6x8b77lIWqqTOdq1azzmkXupD6UWriPLd0JCrFng=="
+ },
+ "node_modules/json-stable-stringify-without-jsonify": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz",
+ "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw=="
+ },
+ "node_modules/jsonfile": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+ "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+ "dependencies": {
+ "universalify": "^2.0.0"
+ },
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/kleur": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/levn": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
+ "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==",
+ "dependencies": {
+ "prelude-ls": "^1.2.1",
+ "type-check": "~0.4.0"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/lines-and-columns": {
+ "version": "1.2.4",
+ "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz",
+ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="
+ },
+ "node_modules/locate-path": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
+ "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==",
+ "dependencies": {
+ "p-locate": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "node_modules/lodash.merge": {
+ "version": "4.6.2",
+ "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz",
+ "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="
+ },
+ "node_modules/lower-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz",
+ "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/lru-cache": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+ "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+ "dependencies": {
+ "yallist": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.5",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+ "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "dependencies": {
+ "braces": "^3.0.2",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/min-indent": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz",
+ "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/minimatch": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/mkdirp": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==",
+ "bin": {
+ "mkdirp": "bin/cmd.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "node_modules/mustache": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz",
+ "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==",
+ "bin": {
+ "mustache": "bin/mustache"
+ }
+ },
+ "node_modules/natural-compare": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz",
+ "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw=="
+ },
+ "node_modules/natural-compare-lite": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz",
+ "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g=="
+ },
+ "node_modules/no-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz",
+ "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==",
+ "dependencies": {
+ "lower-case": "^2.0.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/jimmywarting"
+ },
+ {
+ "type": "github",
+ "url": "https://paypal.me/jimmywarting"
+ }
+ ],
+ "engines": {
+ "node": ">=10.5.0"
+ }
+ },
+ "node_modules/node-fetch": {
+ "version": "3.2.8",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz",
+ "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==",
+ "dependencies": {
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/node-fetch"
+ }
+ },
+ "node_modules/node-watch": {
+ "version": "0.7.3",
+ "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz",
+ "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/normalize-package-data": {
+ "version": "2.5.0",
+ "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz",
+ "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==",
+ "dependencies": {
+ "hosted-git-info": "^2.1.4",
+ "resolve": "^1.10.0",
+ "semver": "2 || 3 || 4 || 5",
+ "validate-npm-package-license": "^3.0.1"
+ }
+ },
+ "node_modules/normalize-package-data/node_modules/semver": {
+ "version": "5.7.1",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
+ "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==",
+ "bin": {
+ "semver": "bin/semver"
+ }
+ },
+ "node_modules/once": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+ "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
+ "dependencies": {
+ "wrappy": "1"
+ }
+ },
+ "node_modules/optionator": {
+ "version": "0.9.1",
+ "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz",
+ "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==",
+ "dependencies": {
+ "deep-is": "^0.1.3",
+ "fast-levenshtein": "^2.0.6",
+ "levn": "^0.4.1",
+ "prelude-ls": "^1.2.1",
+ "type-check": "^0.4.0",
+ "word-wrap": "^1.2.3"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/p-limit": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
+ "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==",
+ "dependencies": {
+ "yocto-queue": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-locate": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz",
+ "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==",
+ "dependencies": {
+ "p-limit": "^3.0.2"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-try": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz",
+ "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/param-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz",
+ "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/parent-module": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz",
+ "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==",
+ "dependencies": {
+ "callsites": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/parse-json": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz",
+ "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==",
+ "dependencies": {
+ "@babel/code-frame": "^7.0.0",
+ "error-ex": "^1.3.1",
+ "json-parse-even-better-errors": "^2.3.0",
+ "lines-and-columns": "^1.1.6"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/pascal-case": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz",
+ "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/path-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz",
+ "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/path-exists": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
+ "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-is-absolute": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+ "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/path-key": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
+ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-parse": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
+ },
+ "node_modules/path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/picocolors": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
+ "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ=="
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/pluralize": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz",
+ "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/prelude-ls": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz",
+ "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==",
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/prettier": {
+ "version": "2.8.3",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.3.tgz",
+ "integrity": "sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw==",
+ "bin": {
+ "prettier": "bin-prettier.js"
+ },
+ "engines": {
+ "node": ">=10.13.0"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
+ }
+ },
+ "node_modules/prettier-linter-helpers": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz",
+ "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==",
+ "dependencies": {
+ "fast-diff": "^1.1.2"
+ },
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/prompts": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+ "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+ "dependencies": {
+ "kleur": "^3.0.3",
+ "sisteransi": "^1.0.5"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/punycode": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
+ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/rambda": {
+ "version": "7.4.0",
+ "resolved": "https://registry.npmjs.org/rambda/-/rambda-7.4.0.tgz",
+ "integrity": "sha512-A9hihu7dUTLOUCM+I8E61V4kRXnN4DwYeK0DwCBydC1MqNI1PidyAtbtpsJlBBzK4icSctEcCQ1bGcLpBuETUQ=="
+ },
+ "node_modules/read-pkg": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz",
+ "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==",
+ "dependencies": {
+ "@types/normalize-package-data": "^2.4.0",
+ "normalize-package-data": "^2.5.0",
+ "parse-json": "^5.0.0",
+ "type-fest": "^0.6.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/read-pkg-up": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz",
+ "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==",
+ "dependencies": {
+ "find-up": "^4.1.0",
+ "read-pkg": "^5.2.0",
+ "type-fest": "^0.8.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/read-pkg-up/node_modules/find-up": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz",
+ "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==",
+ "dependencies": {
+ "locate-path": "^5.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/read-pkg-up/node_modules/locate-path": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz",
+ "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==",
+ "dependencies": {
+ "p-locate": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/read-pkg-up/node_modules/p-limit": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz",
+ "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==",
+ "dependencies": {
+ "p-try": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/read-pkg-up/node_modules/p-locate": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz",
+ "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==",
+ "dependencies": {
+ "p-limit": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/read-pkg-up/node_modules/type-fest": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
+ "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/read-pkg/node_modules/type-fest": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz",
+ "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/regexp-tree": {
+ "version": "0.1.24",
+ "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.24.tgz",
+ "integrity": "sha512-s2aEVuLhvnVJW6s/iPgEGK6R+/xngd2jNQ+xy4bXNDKxZKJH6jpPHY6kVeVv1IeLCHgswRj+Kl3ELaDjG6V1iw==",
+ "bin": {
+ "regexp-tree": "bin/regexp-tree"
+ }
+ },
+ "node_modules/regexpp": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz",
+ "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/mysticatea"
+ }
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/require-from-string": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
+ "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/resolve": {
+ "version": "1.22.1",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz",
+ "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==",
+ "dependencies": {
+ "is-core-module": "^2.9.0",
+ "path-parse": "^1.0.7",
+ "supports-preserve-symlinks-flag": "^1.0.0"
+ },
+ "bin": {
+ "resolve": "bin/resolve"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/resolve-from": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz",
+ "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==",
+ "engines": {
+ "iojs": ">=1.0.0",
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/rimraf": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz",
+ "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==",
+ "dependencies": {
+ "glob": "^7.1.3"
+ },
+ "bin": {
+ "rimraf": "bin.js"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "node_modules/safe-regex": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-2.1.1.tgz",
+ "integrity": "sha512-rx+x8AMzKb5Q5lQ95Zoi6ZbJqwCLkqi3XuJXp5P3rT8OEc6sZCJG5AE5dU3lsgRr/F4Bs31jSlVN+j5KrsGu9A==",
+ "dependencies": {
+ "regexp-tree": "~0.1.1"
+ }
+ },
+ "node_modules/semver": {
+ "version": "7.3.8",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz",
+ "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==",
+ "dependencies": {
+ "lru-cache": "^6.0.0"
+ },
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/sentence-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz",
+ "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==",
+ "dependencies": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "node_modules/shebang-command": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
+ "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
+ "dependencies": {
+ "shebang-regex": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shebang-regex": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
+ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "node_modules/slash": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz",
+ "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/snake-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz",
+ "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==",
+ "dependencies": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/spdx-correct": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
+ "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==",
+ "dependencies": {
+ "spdx-expression-parse": "^3.0.0",
+ "spdx-license-ids": "^3.0.0"
+ }
+ },
+ "node_modules/spdx-exceptions": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz",
+ "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A=="
+ },
+ "node_modules/spdx-expression-parse": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz",
+ "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==",
+ "dependencies": {
+ "spdx-exceptions": "^2.1.0",
+ "spdx-license-ids": "^3.0.0"
+ }
+ },
+ "node_modules/spdx-license-ids": {
+ "version": "3.0.12",
+ "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.12.tgz",
+ "integrity": "sha512-rr+VVSXtRhO4OHbXUiAF7xW3Bo9DuuF6C5jH+q/x15j2jniycgKbxU09Hr0WqlSLUs4i4ltHGXqTe7VHclYWyA=="
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-indent": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz",
+ "integrity": "sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==",
+ "dependencies": {
+ "min-indent": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-json-comments": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
+ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/supports-color": {
+ "version": "5.5.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+ "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+ "dependencies": {
+ "has-flag": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/supports-preserve-symlinks-flag": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz",
+ "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/text-table": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
+ "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw=="
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.1.tgz",
+ "integrity": "sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA=="
+ },
+ "node_modules/tsutils": {
+ "version": "3.21.0",
+ "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz",
+ "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==",
+ "dependencies": {
+ "tslib": "^1.8.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ },
+ "peerDependencies": {
+ "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta"
+ }
+ },
+ "node_modules/tsutils/node_modules/tslib": {
+ "version": "1.14.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
+ "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg=="
+ },
+ "node_modules/type-check": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz",
+ "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==",
+ "dependencies": {
+ "prelude-ls": "^1.2.1"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/type-fest": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz",
+ "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/typescript": {
+ "version": "4.9.4",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz",
+ "integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==",
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=4.2.0"
+ }
+ },
+ "node_modules/universalify": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
+ "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==",
+ "engines": {
+ "node": ">= 10.0.0"
+ }
+ },
+ "node_modules/upper-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz",
+ "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/upper-case-first": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz",
+ "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==",
+ "dependencies": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "node_modules/uri-js": {
+ "version": "4.4.1",
+ "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
+ "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
+ "dependencies": {
+ "punycode": "^2.1.0"
+ }
+ },
+ "node_modules/validate-npm-package-license": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz",
+ "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==",
+ "dependencies": {
+ "spdx-correct": "^3.0.0",
+ "spdx-expression-parse": "^3.0.0"
+ }
+ },
+ "node_modules/vscode-jsonrpc": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.0.2.tgz",
+ "integrity": "sha512-RY7HwI/ydoC1Wwg4gJ3y6LpU9FJRZAUnTYMXthqhFXXu77ErDd/xkREpGuk4MyYkk4a+XDWAMqe0S3KkelYQEQ==",
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/vscode-languageserver": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-8.0.2.tgz",
+ "integrity": "sha512-bpEt2ggPxKzsAOZlXmCJ50bV7VrxwCS5BI4+egUmure/oI/t4OlFzi/YNtVvY24A2UDOZAgwFGgnZPwqSJubkA==",
+ "dependencies": {
+ "vscode-languageserver-protocol": "3.17.2"
+ },
+ "bin": {
+ "installServerIntoExtension": "bin/installServerIntoExtension"
+ }
+ },
+ "node_modules/vscode-languageserver-protocol": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.2.tgz",
+ "integrity": "sha512-8kYisQ3z/SQ2kyjlNeQxbkkTNmVFoQCqkmGrzLH6A9ecPlgTbp3wDTnUNqaUxYr4vlAcloxx8zwy7G5WdguYNg==",
+ "dependencies": {
+ "vscode-jsonrpc": "8.0.2",
+ "vscode-languageserver-types": "3.17.2"
+ }
+ },
+ "node_modules/vscode-languageserver-textdocument": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.8.tgz",
+ "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q=="
+ },
+ "node_modules/vscode-languageserver-types": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.2.tgz",
+ "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA=="
+ },
+ "node_modules/web-streams-polyfill": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz",
+ "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/word-wrap": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
+ "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yallist": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
+ },
+ "node_modules/yargs": {
+ "version": "17.6.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz",
+ "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==",
+ "dependencies": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yocto-queue": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
+ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ }
+ },
+ "dependencies": {
+ "@autorest/csharp": {
+ "version": "3.0.0-beta.20230201.2",
+ "resolved": "https://registry.npmjs.org/@autorest/csharp/-/csharp-3.0.0-beta.20230201.2.tgz",
+ "integrity": "sha512-fa1jLA1tLcS/MPnYdw7jiB/Jchdl0PvjLc4jpEm7VJxYCyWwevi6f5nOBYcOXRWp556bNqB7F0LZrspz+MJBEg=="
+ },
+ "@azure-tools/cadl-apiview": {
+ "version": "0.3.1",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.1.tgz",
+ "integrity": "sha512-VtWb+FsxxLVDrtX7a0nVhXDoAOnsSd3BdXtyk0CSfaAKPOToZtd/H6H++peWNDrr/koaCfSMkRhCjbH5PVmgOQ=="
+ },
+ "@azure-tools/cadl-autorest": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-autorest/-/cadl-autorest-0.25.0.tgz",
+ "integrity": "sha512-4i4siT4uDVm64gCDcuzDT8xikC2XPCMp4k+NWwPBF2v39IUZkDTtvqSWqRKXhpEVRZcTKbTlJLamfzWGfvdBtg==",
+ "requires": {}
+ },
+ "@azure-tools/cadl-azure-core": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-core/-/cadl-azure-core-0.25.0.tgz",
+ "integrity": "sha512-V3yhJ9mUKntAt2AVm4f/sR91H/wWD8CMLUPQm2GwgSe/Fkv9fc4qE6qnE4QUxPGYJUgYeDXYv12qRN2eLId9sA==",
+ "requires": {
+ "@cadl-lang/lint": "~0.39.0"
+ }
+ },
+ "@azure-tools/cadl-csharp": {
+ "version": "0.1.11-beta.20230201.2",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-csharp/-/cadl-csharp-0.1.11-beta.20230201.2.tgz",
+ "integrity": "sha512-JaCz/Ot5pS8yXlrOI5xHN4Dj3MSajVRBfY/OcBmx+pkHHROQ3ZagmK1y1xIBTJJWwniTAudHCsx4acFeUu9JKA==",
+ "requires": {
+ "@autorest/csharp": "3.0.0-beta.20230201.2",
+ "@azure-tools/cadl-autorest": "0.25.0",
+ "@azure-tools/cadl-azure-core": "0.25.0",
+ "@azure-tools/cadl-dpg": "0.25.0",
+ "@cadl-lang/compiler": "0.39.0",
+ "@cadl-lang/eslint-config-cadl": "0.5.0",
+ "@cadl-lang/eslint-plugin": "0.39.0",
+ "@cadl-lang/library-linter": "0.39.0",
+ "@cadl-lang/openapi": "0.39.0",
+ "@cadl-lang/rest": "0.39.0",
+ "@cadl-lang/versioning": "0.39.0",
+ "fs-extra": "^10.1.0",
+ "js-yaml": "^4.1.0",
+ "json-serialize-refs": "^0.1.0-0"
+ }
+ },
+ "@azure-tools/cadl-dpg": {
+ "version": "0.25.0",
+ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-dpg/-/cadl-dpg-0.25.0.tgz",
+ "integrity": "sha512-T4txhl86WH4se3gklRBNBmy81w7C1fY/fkuRLQGgycBqZ1BEOkn7UpExh90alrGs7eNT8YzWcgh9lO1HWn1BQA==",
+ "requires": {}
+ },
+ "@babel/code-frame": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz",
+ "integrity": "sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==",
+ "requires": {
+ "@babel/highlight": "^7.18.6"
+ }
+ },
+ "@babel/helper-validator-identifier": {
+ "version": "7.19.1",
+ "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz",
+ "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w=="
+ },
+ "@babel/highlight": {
+ "version": "7.18.6",
+ "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.18.6.tgz",
+ "integrity": "sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==",
+ "requires": {
+ "@babel/helper-validator-identifier": "^7.18.6",
+ "chalk": "^2.0.0",
+ "js-tokens": "^4.0.0"
+ }
+ },
+ "@cadl-lang/compiler": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/compiler/-/compiler-0.39.0.tgz",
+ "integrity": "sha512-eAEE66PrwmT4QlWjJm8H/YIljI9n7cNDnSIBN1mbfXFLORKauLhkmYfyVvFzCv/SWNJiw+7VwHje23ITJ/tFDA==",
+ "requires": {
+ "@babel/code-frame": "~7.18.6",
+ "ajv": "~8.11.2",
+ "change-case": "~4.1.2",
+ "globby": "~13.1.1",
+ "js-yaml": "~4.1.0",
+ "mkdirp": "~1.0.4",
+ "mustache": "~4.2.0",
+ "node-fetch": "3.2.8",
+ "node-watch": "~0.7.1",
+ "picocolors": "~1.0.0",
+ "prettier": "~2.8.1",
+ "prompts": "~2.4.1",
+ "vscode-languageserver": "~8.0.2",
+ "vscode-languageserver-textdocument": "~1.0.1",
+ "yargs": "~17.6.2"
+ }
+ },
+ "@cadl-lang/eslint-config-cadl": {
+ "version": "0.5.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/eslint-config-cadl/-/eslint-config-cadl-0.5.0.tgz",
+ "integrity": "sha512-H8vM1K/8zyV7lQpT8XPf6VYMz52cil8DUVawdq3JkGrnunLC7woPhzr2Sl9uPg6e9vsiqRi9ZUmB51MIEaO1gA==",
+ "requires": {
+ "@rushstack/eslint-patch": "1.1.0 ",
+ "@typescript-eslint/eslint-plugin": "^5.30.7",
+ "@typescript-eslint/parser": "^5.30.7",
+ "eslint": "^8.12.0",
+ "eslint-config-prettier": "^8.5.0",
+ "eslint-plugin-mocha": "^10.0.5",
+ "eslint-plugin-prettier": "^4.0.0",
+ "eslint-plugin-unicorn": "^42.0.0",
+ "typescript": "~4.9.3"
+ }
+ },
+ "@cadl-lang/eslint-plugin": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/eslint-plugin/-/eslint-plugin-0.39.0.tgz",
+ "integrity": "sha512-TbNbOuWiNABDzkPYQgZK+sa0740U6V9YRwsGn0pdUGHlFkbN/3rQkhyiiEPHfJkQXKrp2Y4gZLGRl0g7MkuDCA==",
+ "requires": {
+ "@typescript-eslint/utils": "~5.26.0"
+ }
+ },
+ "@cadl-lang/library-linter": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/library-linter/-/library-linter-0.39.0.tgz",
+ "integrity": "sha512-omnr7kaF1iSXPlgMG0gQqne531gusjK+PBgAFuy6c4AIAlmDz/h5Xm1Jv95VEIUyAsbvlIhKl5bOZ5+DzzKoHw==",
+ "requires": {}
+ },
+ "@cadl-lang/lint": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/lint/-/lint-0.39.0.tgz",
+ "integrity": "sha512-qaWnOYH68ppEDI4jWhPMk6gUIs7t/VYREAjvjniwjc5IYhHPFz5hzFUjmZOAp1az9bxJVwBVtGp1pSB8LFgXCQ==",
+ "requires": {}
+ },
+ "@cadl-lang/openapi": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/openapi/-/openapi-0.39.0.tgz",
+ "integrity": "sha512-N/NlryVdaFKzzSdbLeko09M5s2aNEnZsMXHYCMCb9b0HLeJJ/cR/nCulTxCoNO1VMN5VWdSaohBtle4EHS/HSw==",
+ "requires": {}
+ },
+ "@cadl-lang/prettier-plugin-cadl": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/prettier-plugin-cadl/-/prettier-plugin-cadl-0.39.0.tgz",
+ "integrity": "sha512-oBr0qYKdVgfTwAv8Db2UcQUbGJTDq1Na/6CkhVWOsPb1k9Rm2ByEDNEKURF7WgC6+YI0A1x2KIECAJDbdrHS7g==",
+ "requires": {
+ "prettier": "~2.8.1"
+ }
+ },
+ "@cadl-lang/rest": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/rest/-/rest-0.39.0.tgz",
+ "integrity": "sha512-KpEpC/kEoeEFT4DpuG6G4kK2kzuQ4sH85P99ched8CLAo2SzWT0WVYEjya1ony+hqKlvm2nrigattX7P1ES8TQ==",
+ "requires": {}
+ },
+ "@cadl-lang/versioning": {
+ "version": "0.39.0",
+ "resolved": "https://registry.npmjs.org/@cadl-lang/versioning/-/versioning-0.39.0.tgz",
+ "integrity": "sha512-mMmqHTo/Cwssb5Y1qC5Fb4rPkyt7JPK+bWT8KH/oprdG3MOJSemyeEIxQtkId3oBdHZiQHG7T9IN80Dks3GE/A==",
+ "requires": {
+ "@cadl-lang/compiler": "~0.39.0"
+ }
+ },
+ "@eslint/eslintrc": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.1.tgz",
+ "integrity": "sha512-XXrH9Uarn0stsyldqDYq8r++mROmWRI1xKMXa640Bb//SY1+ECYX6VzT6Lcx5frD0V30XieqJ0oX9I2Xj5aoMA==",
+ "requires": {
+ "ajv": "^6.12.4",
+ "debug": "^4.3.2",
+ "espree": "^9.4.0",
+ "globals": "^13.19.0",
+ "ignore": "^5.2.0",
+ "import-fresh": "^3.2.1",
+ "js-yaml": "^4.1.0",
+ "minimatch": "^3.1.2",
+ "strip-json-comments": "^3.1.1"
+ },
+ "dependencies": {
+ "ajv": {
+ "version": "6.12.6",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
+ "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
+ "requires": {
+ "fast-deep-equal": "^3.1.1",
+ "fast-json-stable-stringify": "^2.0.0",
+ "json-schema-traverse": "^0.4.1",
+ "uri-js": "^4.2.2"
+ }
+ },
+ "json-schema-traverse": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
+ "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
+ }
+ }
+ },
+ "@humanwhocodes/config-array": {
+ "version": "0.11.8",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.8.tgz",
+ "integrity": "sha512-UybHIJzJnR5Qc/MsD9Kr+RpO2h+/P1GhOwdiLPXK5TWk5sgTdu88bTD9UP+CKbPPh5Rni1u0GjAdYQLemG8g+g==",
+ "requires": {
+ "@humanwhocodes/object-schema": "^1.2.1",
+ "debug": "^4.1.1",
+ "minimatch": "^3.0.5"
+ }
+ },
+ "@humanwhocodes/module-importer": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz",
+ "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA=="
+ },
+ "@humanwhocodes/object-schema": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz",
+ "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA=="
+ },
+ "@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "requires": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ }
+ },
+ "@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A=="
+ },
+ "@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "requires": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ }
+ },
+ "@rushstack/eslint-patch": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@rushstack/eslint-patch/-/eslint-patch-1.1.0.tgz",
+ "integrity": "sha512-JLo+Y592QzIE+q7Dl2pMUtt4q8SKYI5jDrZxrozEQxnGVOyYE+GWK9eLkwTaeN9DDctlaRAQ3TBmzZ1qdLE30A=="
+ },
+ "@types/json-schema": {
+ "version": "7.0.11",
+ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz",
+ "integrity": "sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ=="
+ },
+ "@types/normalize-package-data": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.1.tgz",
+ "integrity": "sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw=="
+ },
+ "@types/semver": {
+ "version": "7.3.13",
+ "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.3.13.tgz",
+ "integrity": "sha512-21cFJr9z3g5dW8B0CVI9g2O9beqaThGQ6ZFBqHfwhzLDKUxaqTIy3vnfah/UPkfOiF2pLq+tGz+W8RyCskuslw=="
+ },
+ "@typescript-eslint/eslint-plugin": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.48.2.tgz",
+ "integrity": "sha512-sR0Gja9Ky1teIq4qJOl0nC+Tk64/uYdX+mi+5iB//MH8gwyx8e3SOyhEzeLZEFEEfCaLf8KJq+Bd/6je1t+CAg==",
+ "requires": {
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/type-utils": "5.48.2",
+ "@typescript-eslint/utils": "5.48.2",
+ "debug": "^4.3.4",
+ "ignore": "^5.2.0",
+ "natural-compare-lite": "^1.4.0",
+ "regexpp": "^3.2.0",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ },
+ "dependencies": {
+ "@typescript-eslint/utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.2.tgz",
+ "integrity": "sha512-2h18c0d7jgkw6tdKTlNaM7wyopbLRBiit8oAxoP89YnuBOzCZ8g8aBCaCqq7h208qUTroL7Whgzam7UY3HVLow==",
+ "requires": {
+ "@types/json-schema": "^7.0.9",
+ "@types/semver": "^7.3.12",
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0",
+ "semver": "^7.3.7"
+ }
+ }
+ }
+ },
+ "@typescript-eslint/parser": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.48.2.tgz",
+ "integrity": "sha512-38zMsKsG2sIuM5Oi/olurGwYJXzmtdsHhn5mI/pQogP+BjYVkK5iRazCQ8RGS0V+YLk282uWElN70zAAUmaYHw==",
+ "requires": {
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "debug": "^4.3.4"
+ }
+ },
+ "@typescript-eslint/scope-manager": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.48.2.tgz",
+ "integrity": "sha512-zEUFfonQid5KRDKoI3O+uP1GnrFd4tIHlvs+sTJXiWuypUWMuDaottkJuR612wQfOkjYbsaskSIURV9xo4f+Fw==",
+ "requires": {
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/visitor-keys": "5.48.2"
+ }
+ },
+ "@typescript-eslint/type-utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.48.2.tgz",
+ "integrity": "sha512-QVWx7J5sPMRiOMJp5dYshPxABRoZV1xbRirqSk8yuIIsu0nvMTZesKErEA3Oix1k+uvsk8Cs8TGJ6kQ0ndAcew==",
+ "requires": {
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "@typescript-eslint/utils": "5.48.2",
+ "debug": "^4.3.4",
+ "tsutils": "^3.21.0"
+ },
+ "dependencies": {
+ "@typescript-eslint/utils": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.48.2.tgz",
+ "integrity": "sha512-2h18c0d7jgkw6tdKTlNaM7wyopbLRBiit8oAxoP89YnuBOzCZ8g8aBCaCqq7h208qUTroL7Whgzam7UY3HVLow==",
+ "requires": {
+ "@types/json-schema": "^7.0.9",
+ "@types/semver": "^7.3.12",
+ "@typescript-eslint/scope-manager": "5.48.2",
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/typescript-estree": "5.48.2",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0",
+ "semver": "^7.3.7"
+ }
+ }
+ }
+ },
+ "@typescript-eslint/types": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.48.2.tgz",
+ "integrity": "sha512-hE7dA77xxu7ByBc6KCzikgfRyBCTst6dZQpwaTy25iMYOnbNljDT4hjhrGEJJ0QoMjrfqrx+j1l1B9/LtKeuqA=="
+ },
+ "@typescript-eslint/typescript-estree": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.48.2.tgz",
+ "integrity": "sha512-bibvD3z6ilnoVxUBFEgkO0k0aFvUc4Cttt0dAreEr+nrAHhWzkO83PEVVuieK3DqcgL6VAK5dkzK8XUVja5Zcg==",
+ "requires": {
+ "@typescript-eslint/types": "5.48.2",
+ "@typescript-eslint/visitor-keys": "5.48.2",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-glob": "^4.0.3",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ },
+ "dependencies": {
+ "globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "requires": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ }
+ },
+ "slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q=="
+ }
+ }
+ },
+ "@typescript-eslint/utils": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.26.0.tgz",
+ "integrity": "sha512-PJFwcTq2Pt4AMOKfe3zQOdez6InIDOjUJJD3v3LyEtxHGVVRK3Vo7Dd923t/4M9hSH2q2CLvcTdxlLPjcIk3eg==",
+ "requires": {
+ "@types/json-schema": "^7.0.9",
+ "@typescript-eslint/scope-manager": "5.26.0",
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/typescript-estree": "5.26.0",
+ "eslint-scope": "^5.1.1",
+ "eslint-utils": "^3.0.0"
+ },
+ "dependencies": {
+ "@typescript-eslint/scope-manager": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.26.0.tgz",
+ "integrity": "sha512-gVzTJUESuTwiju/7NiTb4c5oqod8xt5GhMbExKsCTp6adU3mya6AGJ4Pl9xC7x2DX9UYFsjImC0mA62BCY22Iw==",
+ "requires": {
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/visitor-keys": "5.26.0"
+ }
+ },
+ "@typescript-eslint/types": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.26.0.tgz",
+ "integrity": "sha512-8794JZFE1RN4XaExLWLI2oSXsVImNkl79PzTOOWt9h0UHROwJedNOD2IJyfL0NbddFllcktGIO2aOu10avQQyA=="
+ },
+ "@typescript-eslint/typescript-estree": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.26.0.tgz",
+ "integrity": "sha512-EyGpw6eQDsfD6jIqmXP3rU5oHScZ51tL/cZgFbFBvWuCwrIptl+oueUZzSmLtxFuSOQ9vDcJIs+279gnJkfd1w==",
+ "requires": {
+ "@typescript-eslint/types": "5.26.0",
+ "@typescript-eslint/visitor-keys": "5.26.0",
+ "debug": "^4.3.4",
+ "globby": "^11.1.0",
+ "is-glob": "^4.0.3",
+ "semver": "^7.3.7",
+ "tsutils": "^3.21.0"
+ }
+ },
+ "@typescript-eslint/visitor-keys": {
+ "version": "5.26.0",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.26.0.tgz",
+ "integrity": "sha512-wei+ffqHanYDOQgg/fS6Hcar6wAWv0CUPQ3TZzOWd2BLfgP539rb49bwua8WRAs7R6kOSLn82rfEu2ro6Llt8Q==",
+ "requires": {
+ "@typescript-eslint/types": "5.26.0",
+ "eslint-visitor-keys": "^3.3.0"
+ }
+ },
+ "globby": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz",
+ "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==",
+ "requires": {
+ "array-union": "^2.1.0",
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.9",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^3.0.0"
+ }
+ },
+ "slash": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
+ "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q=="
+ }
+ }
+ },
+ "@typescript-eslint/visitor-keys": {
+ "version": "5.48.2",
+ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.48.2.tgz",
+ "integrity": "sha512-z9njZLSkwmjFWUelGEwEbdf4NwKvfHxvGC0OcGN1Hp/XNDIcJ7D5DpPNPv6x6/mFvc1tQHsaWmpD/a4gOvvCJQ==",
+ "requires": {
+ "@typescript-eslint/types": "5.48.2",
+ "eslint-visitor-keys": "^3.3.0"
+ }
+ },
+ "acorn": {
+ "version": "8.8.1",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.1.tgz",
+ "integrity": "sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA=="
+ },
+ "acorn-jsx": {
+ "version": "5.3.2",
+ "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz",
+ "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==",
+ "requires": {}
+ },
+ "ajv": {
+ "version": "8.11.2",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.2.tgz",
+ "integrity": "sha512-E4bfmKAhGiSTvMfL1Myyycaub+cUEU2/IvpylXkUu7CHBkBj1f/ikdzbD7YQ6FKUbixDxeYvB/xY4fvyroDlQg==",
+ "requires": {
+ "fast-deep-equal": "^3.1.1",
+ "json-schema-traverse": "^1.0.0",
+ "require-from-string": "^2.0.2",
+ "uri-js": "^4.2.2"
+ }
+ },
+ "ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="
+ },
+ "ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "requires": {
+ "color-convert": "^1.9.0"
+ }
+ },
+ "argparse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+ },
+ "array-union": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz",
+ "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw=="
+ },
+ "balanced-match": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
+ "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
+ },
+ "brace-expansion": {
+ "version": "1.1.11",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
+ "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "requires": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "requires": {
+ "fill-range": "^7.0.1"
+ }
+ },
+ "builtin-modules": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz",
+ "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw=="
+ },
+ "callsites": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz",
+ "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ=="
+ },
+ "camel-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz",
+ "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==",
+ "requires": {
+ "pascal-case": "^3.1.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "capital-case": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz",
+ "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "chalk": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
+ "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
+ "requires": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ }
+ },
+ "change-case": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz",
+ "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==",
+ "requires": {
+ "camel-case": "^4.1.2",
+ "capital-case": "^1.0.4",
+ "constant-case": "^3.0.4",
+ "dot-case": "^3.0.4",
+ "header-case": "^2.0.4",
+ "no-case": "^3.0.4",
+ "param-case": "^3.0.4",
+ "pascal-case": "^3.1.2",
+ "path-case": "^3.0.4",
+ "sentence-case": "^3.0.4",
+ "snake-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "ci-info": {
+ "version": "3.7.1",
+ "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.7.1.tgz",
+ "integrity": "sha512-4jYS4MOAaCIStSRwiuxc4B8MYhIe676yO1sYGzARnjXkWpmzZMMYxY6zu8WYWDhSuth5zhrQ1rhNSibyyvv4/w=="
+ },
+ "clean-regexp": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/clean-regexp/-/clean-regexp-1.0.0.tgz",
+ "integrity": "sha512-GfisEZEJvzKrmGWkvfhgzcz/BllN1USeqD2V6tg14OAOgaCD2Z/PUEuxnAZ/nPvmaHRG7a8y77p1T/IRQ4D1Hw==",
+ "requires": {
+ "escape-string-regexp": "^1.0.5"
+ }
+ },
+ "cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "requires": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ }
+ },
+ "color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "requires": {
+ "color-name": "1.1.3"
+ }
+ },
+ "color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+ },
+ "concat-map": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+ "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
+ },
+ "constant-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz",
+ "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case": "^2.0.2"
+ }
+ },
+ "cross-spawn": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
+ "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+ "requires": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ }
+ },
+ "data-uri-to-buffer": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.0.tgz",
+ "integrity": "sha512-Vr3mLBA8qWmcuschSLAOogKgQ/Jwxulv3RNE4FXnYWRGujzrRWQI4m12fQqRkwX06C0KanhLr4hK+GydchZsaA=="
+ },
+ "debug": {
+ "version": "4.3.4",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
+ "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==",
+ "requires": {
+ "ms": "2.1.2"
+ }
+ },
+ "deep-is": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz",
+ "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="
+ },
+ "dir-glob": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
+ "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==",
+ "requires": {
+ "path-type": "^4.0.0"
+ }
+ },
+ "doctrine": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz",
+ "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==",
+ "requires": {
+ "esutils": "^2.0.2"
+ }
+ },
+ "dot-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz",
+ "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "error-ex": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz",
+ "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==",
+ "requires": {
+ "is-arrayish": "^0.2.1"
+ }
+ },
+ "escalade": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz",
+ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw=="
+ },
+ "escape-string-regexp": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+ "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg=="
+ },
+ "eslint": {
+ "version": "8.32.0",
+ "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.32.0.tgz",
+ "integrity": "sha512-nETVXpnthqKPFyuY2FNjz/bEd6nbosRgKbkgS/y1C7LJop96gYHWpiguLecMHQ2XCPxn77DS0P+68WzG6vkZSQ==",
+ "requires": {
+ "@eslint/eslintrc": "^1.4.1",
+ "@humanwhocodes/config-array": "^0.11.8",
+ "@humanwhocodes/module-importer": "^1.0.1",
+ "@nodelib/fs.walk": "^1.2.8",
+ "ajv": "^6.10.0",
+ "chalk": "^4.0.0",
+ "cross-spawn": "^7.0.2",
+ "debug": "^4.3.2",
+ "doctrine": "^3.0.0",
+ "escape-string-regexp": "^4.0.0",
+ "eslint-scope": "^7.1.1",
+ "eslint-utils": "^3.0.0",
+ "eslint-visitor-keys": "^3.3.0",
+ "espree": "^9.4.0",
+ "esquery": "^1.4.0",
+ "esutils": "^2.0.2",
+ "fast-deep-equal": "^3.1.3",
+ "file-entry-cache": "^6.0.1",
+ "find-up": "^5.0.0",
+ "glob-parent": "^6.0.2",
+ "globals": "^13.19.0",
+ "grapheme-splitter": "^1.0.4",
+ "ignore": "^5.2.0",
+ "import-fresh": "^3.0.0",
+ "imurmurhash": "^0.1.4",
+ "is-glob": "^4.0.0",
+ "is-path-inside": "^3.0.3",
+ "js-sdsl": "^4.1.4",
+ "js-yaml": "^4.1.0",
+ "json-stable-stringify-without-jsonify": "^1.0.1",
+ "levn": "^0.4.1",
+ "lodash.merge": "^4.6.2",
+ "minimatch": "^3.1.2",
+ "natural-compare": "^1.4.0",
+ "optionator": "^0.9.1",
+ "regexpp": "^3.2.0",
+ "strip-ansi": "^6.0.1",
+ "strip-json-comments": "^3.1.0",
+ "text-table": "^0.2.0"
+ },
+ "dependencies": {
+ "ajv": {
+ "version": "6.12.6",
+ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
+ "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
+ "requires": {
+ "fast-deep-equal": "^3.1.1",
+ "fast-json-stable-stringify": "^2.0.0",
+ "json-schema-traverse": "^0.4.1",
+ "uri-js": "^4.2.2"
+ }
+ },
+ "ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "requires": {
+ "color-convert": "^2.0.1"
+ }
+ },
+ "chalk": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+ "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
+ "requires": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ }
+ },
+ "color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "requires": {
+ "color-name": "~1.1.4"
+ }
+ },
+ "color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "escape-string-regexp": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+ "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA=="
+ },
+ "eslint-scope": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.1.1.tgz",
+ "integrity": "sha512-QKQM/UXpIiHcLqJ5AOyIW7XZmzjkzQXYE54n1++wb0u9V/abW3l9uQnxX8Z5Xd18xyKIMTUAyQ0k1e8pz6LUrw==",
+ "requires": {
+ "esrecurse": "^4.3.0",
+ "estraverse": "^5.2.0"
+ }
+ },
+ "estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA=="
+ },
+ "glob-parent": {
+ "version": "6.0.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz",
+ "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==",
+ "requires": {
+ "is-glob": "^4.0.3"
+ }
+ },
+ "has-flag": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
+ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
+ },
+ "json-schema-traverse": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
+ "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
+ },
+ "supports-color": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
+ "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
+ "requires": {
+ "has-flag": "^4.0.0"
+ }
+ }
+ }
+ },
+ "eslint-config-prettier": {
+ "version": "8.6.0",
+ "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-8.6.0.tgz",
+ "integrity": "sha512-bAF0eLpLVqP5oEVUFKpMA+NnRFICwn9X8B5jrR9FcqnYBuPbqWEjTEspPWMj5ye6czoSLDweCzSo3Ko7gGrZaA==",
+ "requires": {}
+ },
+ "eslint-plugin-mocha": {
+ "version": "10.1.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-mocha/-/eslint-plugin-mocha-10.1.0.tgz",
+ "integrity": "sha512-xLqqWUF17llsogVOC+8C6/jvQ+4IoOREbN7ZCHuOHuD6cT5cDD4h7f2LgsZuzMAiwswWE21tO7ExaknHVDrSkw==",
+ "requires": {
+ "eslint-utils": "^3.0.0",
+ "rambda": "^7.1.0"
+ }
+ },
+ "eslint-plugin-prettier": {
+ "version": "4.2.1",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-4.2.1.tgz",
+ "integrity": "sha512-f/0rXLXUt0oFYs8ra4w49wYZBG5GKZpAYsJSm6rnYL5uVDjd+zowwMwVZHnAjf4edNrKpCDYfXDgmRE/Ak7QyQ==",
+ "requires": {
+ "prettier-linter-helpers": "^1.0.0"
+ }
+ },
+ "eslint-plugin-unicorn": {
+ "version": "42.0.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-42.0.0.tgz",
+ "integrity": "sha512-ixBsbhgWuxVaNlPTT8AyfJMlhyC5flCJFjyK3oKE8TRrwBnaHvUbuIkCM1lqg8ryYrFStL/T557zfKzX4GKSlg==",
+ "requires": {
+ "@babel/helper-validator-identifier": "^7.15.7",
+ "ci-info": "^3.3.0",
+ "clean-regexp": "^1.0.0",
+ "eslint-utils": "^3.0.0",
+ "esquery": "^1.4.0",
+ "indent-string": "^4.0.0",
+ "is-builtin-module": "^3.1.0",
+ "lodash": "^4.17.21",
+ "pluralize": "^8.0.0",
+ "read-pkg-up": "^7.0.1",
+ "regexp-tree": "^0.1.24",
+ "safe-regex": "^2.1.1",
+ "semver": "^7.3.5",
+ "strip-indent": "^3.0.0"
+ }
+ },
+ "eslint-scope": {
+ "version": "5.1.1",
+ "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz",
+ "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==",
+ "requires": {
+ "esrecurse": "^4.3.0",
+ "estraverse": "^4.1.1"
+ }
+ },
+ "eslint-utils": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz",
+ "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==",
+ "requires": {
+ "eslint-visitor-keys": "^2.0.0"
+ },
+ "dependencies": {
+ "eslint-visitor-keys": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz",
+ "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw=="
+ }
+ }
+ },
+ "eslint-visitor-keys": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.3.0.tgz",
+ "integrity": "sha512-mQ+suqKJVyeuwGYHAdjMFqjCyfl8+Ldnxuyp3ldiMBFKkvytrXUZWaiPCEav8qDHKty44bD+qV1IP4T+w+xXRA=="
+ },
+ "espree": {
+ "version": "9.4.1",
+ "resolved": "https://registry.npmjs.org/espree/-/espree-9.4.1.tgz",
+ "integrity": "sha512-XwctdmTO6SIvCzd9810yyNzIrOrqNYV9Koizx4C/mRhf9uq0o4yHoCEU/670pOxOL/MSraektvSAji79kX90Vg==",
+ "requires": {
+ "acorn": "^8.8.0",
+ "acorn-jsx": "^5.3.2",
+ "eslint-visitor-keys": "^3.3.0"
+ }
+ },
+ "esquery": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz",
+ "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==",
+ "requires": {
+ "estraverse": "^5.1.0"
+ },
+ "dependencies": {
+ "estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA=="
+ }
+ }
+ },
+ "esrecurse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz",
+ "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==",
+ "requires": {
+ "estraverse": "^5.2.0"
+ },
+ "dependencies": {
+ "estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA=="
+ }
+ }
+ },
+ "estraverse": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz",
+ "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw=="
+ },
+ "esutils": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
+ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g=="
+ },
+ "fast-deep-equal": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
+ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="
+ },
+ "fast-diff": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.2.0.tgz",
+ "integrity": "sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w=="
+ },
+ "fast-glob": {
+ "version": "3.2.12",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz",
+ "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==",
+ "requires": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.4"
+ }
+ },
+ "fast-json-stable-stringify": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz",
+ "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw=="
+ },
+ "fast-levenshtein": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
+ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="
+ },
+ "fastq": {
+ "version": "1.14.0",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.14.0.tgz",
+ "integrity": "sha512-eR2D+V9/ExcbF9ls441yIuN6TI2ED1Y2ZcA5BmMtJsOkWOFRJQ0Jt0g1UwqXJJVAb+V+umH5Dfr8oh4EVP7VVg==",
+ "requires": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "fetch-blob": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz",
+ "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==",
+ "requires": {
+ "node-domexception": "^1.0.0",
+ "web-streams-polyfill": "^3.0.3"
+ }
+ },
+ "file-entry-cache": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz",
+ "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==",
+ "requires": {
+ "flat-cache": "^3.0.4"
+ }
+ },
+ "fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "requires": {
+ "to-regex-range": "^5.0.1"
+ }
+ },
+ "find-up": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz",
+ "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==",
+ "requires": {
+ "locate-path": "^6.0.0",
+ "path-exists": "^4.0.0"
+ }
+ },
+ "flat-cache": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz",
+ "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==",
+ "requires": {
+ "flatted": "^3.1.0",
+ "rimraf": "^3.0.2"
+ }
+ },
+ "flatted": {
+ "version": "3.2.7",
+ "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.7.tgz",
+ "integrity": "sha512-5nqDSxl8nn5BSNxyR3n4I6eDmbolI6WT+QqR547RwxQapgjQBmtktdP+HTBb/a/zLsbzERTONyUB5pefh5TtjQ=="
+ },
+ "formdata-polyfill": {
+ "version": "4.0.10",
+ "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz",
+ "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==",
+ "requires": {
+ "fetch-blob": "^3.1.2"
+ }
+ },
+ "fs-extra": {
+ "version": "10.1.0",
+ "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz",
+ "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==",
+ "requires": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ }
+ },
+ "fs.realpath": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+ "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
+ },
+ "function-bind": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz",
+ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A=="
+ },
+ "get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg=="
+ },
+ "glob": {
+ "version": "7.2.3",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
+ "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
+ "requires": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.1.1",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ }
+ },
+ "glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "requires": {
+ "is-glob": "^4.0.1"
+ }
+ },
+ "globals": {
+ "version": "13.19.0",
+ "resolved": "https://registry.npmjs.org/globals/-/globals-13.19.0.tgz",
+ "integrity": "sha512-dkQ957uSRWHw7CFXLUtUHQI3g3aWApYhfNR2O6jn/907riyTYKVBmxYVROkBcY614FSSeSJh7Xm7SrUWCxvJMQ==",
+ "requires": {
+ "type-fest": "^0.20.2"
+ }
+ },
+ "globby": {
+ "version": "13.1.2",
+ "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.2.tgz",
+ "integrity": "sha512-LKSDZXToac40u8Q1PQtZihbNdTYSNMuWe+K5l+oa6KgDzSvVrHXlJy40hUP522RjAIoNLJYBJi7ow+rbFpIhHQ==",
+ "requires": {
+ "dir-glob": "^3.0.1",
+ "fast-glob": "^3.2.11",
+ "ignore": "^5.2.0",
+ "merge2": "^1.4.1",
+ "slash": "^4.0.0"
+ }
+ },
+ "graceful-fs": {
+ "version": "4.2.10",
+ "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz",
+ "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA=="
+ },
+ "grapheme-splitter": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/grapheme-splitter/-/grapheme-splitter-1.0.4.tgz",
+ "integrity": "sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ=="
+ },
+ "has": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
+ "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==",
+ "requires": {
+ "function-bind": "^1.1.1"
+ }
+ },
+ "has-flag": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+ "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw=="
+ },
+ "header-case": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz",
+ "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==",
+ "requires": {
+ "capital-case": "^1.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "hosted-git-info": {
+ "version": "2.8.9",
+ "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz",
+ "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw=="
+ },
+ "ignore": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.1.tgz",
+ "integrity": "sha512-d2qQLzTJ9WxQftPAuEQpSPmKqzxePjzVbpAVv62AQ64NTL+wR4JkrVqR/LqFsFEUsHDAiId52mJteHDFuDkElA=="
+ },
+ "import-fresh": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz",
+ "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==",
+ "requires": {
+ "parent-module": "^1.0.0",
+ "resolve-from": "^4.0.0"
+ }
+ },
+ "imurmurhash": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz",
+ "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA=="
+ },
+ "indent-string": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz",
+ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg=="
+ },
+ "inflight": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
+ "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
+ "requires": {
+ "once": "^1.3.0",
+ "wrappy": "1"
+ }
+ },
+ "inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "is-arrayish": {
+ "version": "0.2.1",
+ "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz",
+ "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg=="
+ },
+ "is-builtin-module": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.0.tgz",
+ "integrity": "sha512-phDA4oSGt7vl1n5tJvTWooWWAsXLY+2xCnxNqvKhGEzujg+A43wPlPOyDg3C8XQHN+6k/JTQWJ/j0dQh/qr+Hw==",
+ "requires": {
+ "builtin-modules": "^3.3.0"
+ }
+ },
+ "is-core-module": {
+ "version": "2.11.0",
+ "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.11.0.tgz",
+ "integrity": "sha512-RRjxlvLDkD1YJwDbroBHMb+cukurkDWNyHx7D3oNB5x9rb5ogcksMC5wHCadcXoo67gVr/+3GFySh3134zi6rw==",
+ "requires": {
+ "has": "^1.0.3"
+ }
+ },
+ "is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ=="
+ },
+ "is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg=="
+ },
+ "is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "requires": {
+ "is-extglob": "^2.1.1"
+ }
+ },
+ "is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="
+ },
+ "is-path-inside": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz",
+ "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ=="
+ },
+ "isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
+ },
+ "js-sdsl": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/js-sdsl/-/js-sdsl-4.2.0.tgz",
+ "integrity": "sha512-dyBIzQBDkCqCu+0upx25Y2jGdbTGxE9fshMsCdK0ViOongpV+n5tXRcZY9v7CaVQ79AGS9KA1KHtojxiM7aXSQ=="
+ },
+ "js-tokens": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+ "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
+ },
+ "js-yaml": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+ "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "requires": {
+ "argparse": "^2.0.1"
+ }
+ },
+ "json-parse-even-better-errors": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz",
+ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w=="
+ },
+ "json-schema-traverse": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
+ "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="
+ },
+ "json-serialize-refs": {
+ "version": "0.1.0-0",
+ "resolved": "https://registry.npmjs.org/json-serialize-refs/-/json-serialize-refs-0.1.0-0.tgz",
+ "integrity": "sha512-SnNMfW2RRPDXIMKa8zdLb59UjMSI1UFZCtIb8ae68GcZ0a6x8b77lIWqqTOdq1azzmkXupD6UWriPLd0JCrFng=="
+ },
+ "json-stable-stringify-without-jsonify": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz",
+ "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw=="
+ },
+ "jsonfile": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
+ "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
+ "requires": {
+ "graceful-fs": "^4.1.6",
+ "universalify": "^2.0.0"
+ }
+ },
+ "kleur": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w=="
+ },
+ "levn": {
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
+ "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==",
+ "requires": {
+ "prelude-ls": "^1.2.1",
+ "type-check": "~0.4.0"
+ }
+ },
+ "lines-and-columns": {
+ "version": "1.2.4",
+ "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz",
+ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="
+ },
+ "locate-path": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
+ "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==",
+ "requires": {
+ "p-locate": "^5.0.0"
+ }
+ },
+ "lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+ },
+ "lodash.merge": {
+ "version": "4.6.2",
+ "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz",
+ "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="
+ },
+ "lower-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz",
+ "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "lru-cache": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+ "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+ "requires": {
+ "yallist": "^4.0.0"
+ }
+ },
+ "merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg=="
+ },
+ "micromatch": {
+ "version": "4.0.5",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+ "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "requires": {
+ "braces": "^3.0.2",
+ "picomatch": "^2.3.1"
+ }
+ },
+ "min-indent": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz",
+ "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg=="
+ },
+ "minimatch": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+ "requires": {
+ "brace-expansion": "^1.1.7"
+ }
+ },
+ "mkdirp": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
+ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="
+ },
+ "ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "mustache": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz",
+ "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ=="
+ },
+ "natural-compare": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz",
+ "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw=="
+ },
+ "natural-compare-lite": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz",
+ "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g=="
+ },
+ "no-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz",
+ "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==",
+ "requires": {
+ "lower-case": "^2.0.2",
+ "tslib": "^2.0.3"
+ }
+ },
+ "node-domexception": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
+ "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ=="
+ },
+ "node-fetch": {
+ "version": "3.2.8",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz",
+ "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==",
+ "requires": {
+ "data-uri-to-buffer": "^4.0.0",
+ "fetch-blob": "^3.1.4",
+ "formdata-polyfill": "^4.0.10"
+ }
+ },
+ "node-watch": {
+ "version": "0.7.3",
+ "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz",
+ "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ=="
+ },
+ "normalize-package-data": {
+ "version": "2.5.0",
+ "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz",
+ "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==",
+ "requires": {
+ "hosted-git-info": "^2.1.4",
+ "resolve": "^1.10.0",
+ "semver": "2 || 3 || 4 || 5",
+ "validate-npm-package-license": "^3.0.1"
+ },
+ "dependencies": {
+ "semver": {
+ "version": "5.7.1",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
+ "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ=="
+ }
+ }
+ },
+ "once": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+ "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
+ "requires": {
+ "wrappy": "1"
+ }
+ },
+ "optionator": {
+ "version": "0.9.1",
+ "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz",
+ "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==",
+ "requires": {
+ "deep-is": "^0.1.3",
+ "fast-levenshtein": "^2.0.6",
+ "levn": "^0.4.1",
+ "prelude-ls": "^1.2.1",
+ "type-check": "^0.4.0",
+ "word-wrap": "^1.2.3"
+ }
+ },
+ "p-limit": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
+ "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==",
+ "requires": {
+ "yocto-queue": "^0.1.0"
+ }
+ },
+ "p-locate": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz",
+ "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==",
+ "requires": {
+ "p-limit": "^3.0.2"
+ }
+ },
+ "p-try": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz",
+ "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ=="
+ },
+ "param-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz",
+ "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "parent-module": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz",
+ "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==",
+ "requires": {
+ "callsites": "^3.0.0"
+ }
+ },
+ "parse-json": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz",
+ "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==",
+ "requires": {
+ "@babel/code-frame": "^7.0.0",
+ "error-ex": "^1.3.1",
+ "json-parse-even-better-errors": "^2.3.0",
+ "lines-and-columns": "^1.1.6"
+ }
+ },
+ "pascal-case": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz",
+ "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "path-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz",
+ "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "path-exists": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
+ "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w=="
+ },
+ "path-is-absolute": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+ "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg=="
+ },
+ "path-key": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
+ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="
+ },
+ "path-parse": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw=="
+ },
+ "path-type": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz",
+ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw=="
+ },
+ "picocolors": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
+ "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ=="
+ },
+ "picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA=="
+ },
+ "pluralize": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz",
+ "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA=="
+ },
+ "prelude-ls": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz",
+ "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g=="
+ },
+ "prettier": {
+ "version": "2.8.3",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.3.tgz",
+ "integrity": "sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw=="
+ },
+ "prettier-linter-helpers": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz",
+ "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==",
+ "requires": {
+ "fast-diff": "^1.1.2"
+ }
+ },
+ "prompts": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+ "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+ "requires": {
+ "kleur": "^3.0.3",
+ "sisteransi": "^1.0.5"
+ }
+ },
+ "punycode": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
+ "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A=="
+ },
+ "queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="
+ },
+ "rambda": {
+ "version": "7.4.0",
+ "resolved": "https://registry.npmjs.org/rambda/-/rambda-7.4.0.tgz",
+ "integrity": "sha512-A9hihu7dUTLOUCM+I8E61V4kRXnN4DwYeK0DwCBydC1MqNI1PidyAtbtpsJlBBzK4icSctEcCQ1bGcLpBuETUQ=="
+ },
+ "read-pkg": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz",
+ "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==",
+ "requires": {
+ "@types/normalize-package-data": "^2.4.0",
+ "normalize-package-data": "^2.5.0",
+ "parse-json": "^5.0.0",
+ "type-fest": "^0.6.0"
+ },
+ "dependencies": {
+ "type-fest": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz",
+ "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg=="
+ }
+ }
+ },
+ "read-pkg-up": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz",
+ "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==",
+ "requires": {
+ "find-up": "^4.1.0",
+ "read-pkg": "^5.2.0",
+ "type-fest": "^0.8.1"
+ },
+ "dependencies": {
+ "find-up": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz",
+ "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==",
+ "requires": {
+ "locate-path": "^5.0.0",
+ "path-exists": "^4.0.0"
+ }
+ },
+ "locate-path": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz",
+ "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==",
+ "requires": {
+ "p-locate": "^4.1.0"
+ }
+ },
+ "p-limit": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz",
+ "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==",
+ "requires": {
+ "p-try": "^2.0.0"
+ }
+ },
+ "p-locate": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz",
+ "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==",
+ "requires": {
+ "p-limit": "^2.2.0"
+ }
+ },
+ "type-fest": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
+ "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA=="
+ }
+ }
+ },
+ "regexp-tree": {
+ "version": "0.1.24",
+ "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.24.tgz",
+ "integrity": "sha512-s2aEVuLhvnVJW6s/iPgEGK6R+/xngd2jNQ+xy4bXNDKxZKJH6jpPHY6kVeVv1IeLCHgswRj+Kl3ELaDjG6V1iw=="
+ },
+ "regexpp": {
+ "version": "3.2.0",
+ "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz",
+ "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg=="
+ },
+ "require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q=="
+ },
+ "require-from-string": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz",
+ "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="
+ },
+ "resolve": {
+ "version": "1.22.1",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.1.tgz",
+ "integrity": "sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==",
+ "requires": {
+ "is-core-module": "^2.9.0",
+ "path-parse": "^1.0.7",
+ "supports-preserve-symlinks-flag": "^1.0.0"
+ }
+ },
+ "resolve-from": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz",
+ "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="
+ },
+ "reusify": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw=="
+ },
+ "rimraf": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz",
+ "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==",
+ "requires": {
+ "glob": "^7.1.3"
+ }
+ },
+ "run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "requires": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "safe-regex": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/safe-regex/-/safe-regex-2.1.1.tgz",
+ "integrity": "sha512-rx+x8AMzKb5Q5lQ95Zoi6ZbJqwCLkqi3XuJXp5P3rT8OEc6sZCJG5AE5dU3lsgRr/F4Bs31jSlVN+j5KrsGu9A==",
+ "requires": {
+ "regexp-tree": "~0.1.1"
+ }
+ },
+ "semver": {
+ "version": "7.3.8",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz",
+ "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==",
+ "requires": {
+ "lru-cache": "^6.0.0"
+ }
+ },
+ "sentence-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz",
+ "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==",
+ "requires": {
+ "no-case": "^3.0.4",
+ "tslib": "^2.0.3",
+ "upper-case-first": "^2.0.2"
+ }
+ },
+ "shebang-command": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
+ "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
+ "requires": {
+ "shebang-regex": "^3.0.0"
+ }
+ },
+ "shebang-regex": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
+ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A=="
+ },
+ "sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "slash": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz",
+ "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew=="
+ },
+ "snake-case": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz",
+ "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==",
+ "requires": {
+ "dot-case": "^3.0.4",
+ "tslib": "^2.0.3"
+ }
+ },
+ "spdx-correct": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
+ "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==",
+ "requires": {
+ "spdx-expression-parse": "^3.0.0",
+ "spdx-license-ids": "^3.0.0"
+ }
+ },
+ "spdx-exceptions": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz",
+ "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A=="
+ },
+ "spdx-expression-parse": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz",
+ "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==",
+ "requires": {
+ "spdx-exceptions": "^2.1.0",
+ "spdx-license-ids": "^3.0.0"
+ }
+ },
+ "spdx-license-ids": {
+ "version": "3.0.12",
+ "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.12.tgz",
+ "integrity": "sha512-rr+VVSXtRhO4OHbXUiAF7xW3Bo9DuuF6C5jH+q/x15j2jniycgKbxU09Hr0WqlSLUs4i4ltHGXqTe7VHclYWyA=="
+ },
+ "string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "requires": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ }
+ },
+ "strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "requires": {
+ "ansi-regex": "^5.0.1"
+ }
+ },
+ "strip-indent": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz",
+ "integrity": "sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==",
+ "requires": {
+ "min-indent": "^1.0.0"
+ }
+ },
+ "strip-json-comments": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
+ "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig=="
+ },
+ "supports-color": {
+ "version": "5.5.0",
+ "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+ "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+ "requires": {
+ "has-flag": "^3.0.0"
+ }
+ },
+ "supports-preserve-symlinks-flag": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz",
+ "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w=="
+ },
+ "text-table": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz",
+ "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw=="
+ },
+ "to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "requires": {
+ "is-number": "^7.0.0"
+ }
+ },
+ "tslib": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.1.tgz",
+ "integrity": "sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA=="
+ },
+ "tsutils": {
+ "version": "3.21.0",
+ "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz",
+ "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==",
+ "requires": {
+ "tslib": "^1.8.1"
+ },
+ "dependencies": {
+ "tslib": {
+ "version": "1.14.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
+ "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg=="
+ }
+ }
+ },
+ "type-check": {
+ "version": "0.4.0",
+ "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz",
+ "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==",
+ "requires": {
+ "prelude-ls": "^1.2.1"
+ }
+ },
+ "type-fest": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz",
+ "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ=="
+ },
+ "typescript": {
+ "version": "4.9.4",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.4.tgz",
+ "integrity": "sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg=="
+ },
+ "universalify": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
+ "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ=="
+ },
+ "upper-case": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz",
+ "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "upper-case-first": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz",
+ "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==",
+ "requires": {
+ "tslib": "^2.0.3"
+ }
+ },
+ "uri-js": {
+ "version": "4.4.1",
+ "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
+ "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==",
+ "requires": {
+ "punycode": "^2.1.0"
+ }
+ },
+ "validate-npm-package-license": {
+ "version": "3.0.4",
+ "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz",
+ "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==",
+ "requires": {
+ "spdx-correct": "^3.0.0",
+ "spdx-expression-parse": "^3.0.0"
+ }
+ },
+ "vscode-jsonrpc": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.0.2.tgz",
+ "integrity": "sha512-RY7HwI/ydoC1Wwg4gJ3y6LpU9FJRZAUnTYMXthqhFXXu77ErDd/xkREpGuk4MyYkk4a+XDWAMqe0S3KkelYQEQ=="
+ },
+ "vscode-languageserver": {
+ "version": "8.0.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-8.0.2.tgz",
+ "integrity": "sha512-bpEt2ggPxKzsAOZlXmCJ50bV7VrxwCS5BI4+egUmure/oI/t4OlFzi/YNtVvY24A2UDOZAgwFGgnZPwqSJubkA==",
+ "requires": {
+ "vscode-languageserver-protocol": "3.17.2"
+ }
+ },
+ "vscode-languageserver-protocol": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.2.tgz",
+ "integrity": "sha512-8kYisQ3z/SQ2kyjlNeQxbkkTNmVFoQCqkmGrzLH6A9ecPlgTbp3wDTnUNqaUxYr4vlAcloxx8zwy7G5WdguYNg==",
+ "requires": {
+ "vscode-jsonrpc": "8.0.2",
+ "vscode-languageserver-types": "3.17.2"
+ }
+ },
+ "vscode-languageserver-textdocument": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.8.tgz",
+ "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q=="
+ },
+ "vscode-languageserver-types": {
+ "version": "3.17.2",
+ "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.2.tgz",
+ "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA=="
+ },
+ "web-streams-polyfill": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz",
+ "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q=="
+ },
+ "which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "requires": {
+ "isexe": "^2.0.0"
+ }
+ },
+ "word-wrap": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
+ "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ=="
+ },
+ "wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "requires": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "dependencies": {
+ "ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "requires": {
+ "color-convert": "^2.0.1"
+ }
+ },
+ "color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "requires": {
+ "color-name": "~1.1.4"
+ }
+ },
+ "color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ }
+ }
+ },
+ "wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
+ },
+ "y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA=="
+ },
+ "yallist": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
+ },
+ "yargs": {
+ "version": "17.6.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz",
+ "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==",
+ "requires": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ }
+ },
+ "yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw=="
+ },
+ "yocto-queue": {
+ "version": "0.1.0",
+ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
+ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="
+ }
+ }
+}
diff --git a/specification/cognitiveservices/OpenAI.Inference/package.json b/specification/cognitiveservices/OpenAI.Inference/package.json
new file mode 100644
index 000000000000..d1f173e58cf8
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/package.json
@@ -0,0 +1,19 @@
+{
+ "name": "@cadl-api-spec/azure-openai-service-api",
+ "author": "Microsoft Corporation",
+ "description": "Azure OpenAI APIs for completions and search",
+ "license": "MIT",
+ "dependencies": {
+ "@cadl-lang/compiler": "^0.39.0",
+ "@cadl-lang/rest": "^0.39.0",
+ "@cadl-lang/versioning": "^0.39.0",
+ "@cadl-lang/prettier-plugin-cadl": "^0.39",
+ "@azure-tools/cadl-azure-core": "^0.25.0",
+ "@azure-tools/cadl-autorest": "^0.25.0",
+ "@azure-tools/cadl-apiview": "~0.3.1",
+ "@azure-tools/cadl-dpg": "0.25.0",
+ "@azure-tools/cadl-csharp": "0.1.11-beta.20230201.2",
+ "prettier": "^2.8.3"
+ },
+ "private": true
+}
diff --git a/specification/cognitiveservices/OpenAI.Inference/routes.cadl b/specification/cognitiveservices/OpenAI.Inference/routes.cadl
new file mode 100644
index 000000000000..a754d35961a9
--- /dev/null
+++ b/specification/cognitiveservices/OpenAI.Inference/routes.cadl
@@ -0,0 +1,26 @@
+import "@azure-tools/cadl-azure-core";
+import "@cadl-lang/rest";
+import "@azure-tools/cadl-dpg";
+
+import "./models/completions.create.cadl";
+import "./models/embeddings.create.cadl";
+
+using Cadl.Rest;
+using Cadl.Http;
+using Azure.Core;
+using Azure.DPG;
+
+namespace Azure.OpenAI;
+
+@doc("Return the embeddings for a given prompt.")
+@Cadl.Rest.actionSeparator("/")
+@action("embeddings")
+@convenienceAPI
+op getEmbeddings is Azure.Core.ResourceAction;
+
+
+@doc("Return the completions for a given prompt.")
+@Cadl.Rest.actionSeparator("/")
+@action("completions")
+@convenienceAPI
+op getCompletions is Azure.Core.ResourceAction;
diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json
index 3ffa70896712..3834617a2cc8 100644
--- a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json
+++ b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json
@@ -724,29 +724,6 @@
]
}
},
- "Multivariate.DataSchemaValues": {
- "type": "string",
- "enum": [
- "OneTable",
- "MultiTable"
- ],
- "x-ms-enum": {
- "name": "DataSchemaValues",
- "modelAsString": false,
- "values": [
- {
- "name": "OneTable",
- "value": "OneTable",
- "description": "OneTable means that your input data are all in one CSV file, which contains one 'timestamp' column and several variable columns. The default DataSchema is OneTable."
- },
- {
- "name": "MultiTable",
- "value": "MultiTable",
- "description": "MultiTable means that your input data are separated in multiple CSV files, in each file containing one 'timestamp' column and one 'variable' column, and the CSV file name should indicate the name of the variable. The default DataSchema is OneTable."
- }
- ]
- }
- },
"Multivariate.DiagnosticsInfo": {
"type": "object",
"properties": {
@@ -799,20 +776,6 @@
"modelAsString": true
}
},
- "Multivariate.FillNAMethodKnownValues": {
- "type": "string",
- "enum": [
- "Previous",
- "Subsequent",
- "Linear",
- "Zero",
- "Fixed"
- ],
- "x-ms-enum": {
- "name": "FillNAMethodKnownValues",
- "modelAsString": false
- }
- },
"Multivariate.ModelInfo": {
"type": "object",
"properties": {
@@ -1272,26 +1235,6 @@
"modelAsString": true
}
},
- "Univariate.AnomalyDetectorErrorCodesKnownValues": {
- "type": "string",
- "enum": [
- "InvalidCustomInterval",
- "BadArgument",
- "InvalidGranularity",
- "InvalidPeriod",
- "InvalidModelArgument",
- "InvalidSeries",
- "InvalidJsonFormat",
- "RequiredGranularity",
- "RequiredSeries",
- "InvalidImputeMode",
- "InvalidImputeFixedValue"
- ],
- "x-ms-enum": {
- "name": "AnomalyDetectorErrorCodesKnownValues",
- "modelAsString": false
- }
- },
"Univariate.ImputeMode": {
"type": "string",
"enum": [
@@ -1333,47 +1276,6 @@
]
}
},
- "Univariate.ImputeModeKnownValues": {
- "type": "string",
- "enum": [
- "auto",
- "previous",
- "linear",
- "fixed",
- "zero",
- "notFill"
- ],
- "x-ms-enum": {
- "name": "ImputeModeKnownValues",
- "modelAsString": false,
- "values": [
- {
- "name": "Auto",
- "value": "auto"
- },
- {
- "name": "Previous",
- "value": "previous"
- },
- {
- "name": "Linear",
- "value": "linear"
- },
- {
- "name": "Fixed",
- "value": "fixed"
- },
- {
- "name": "Zero",
- "value": "zero"
- },
- {
- "name": "NotFill",
- "value": "notFill"
- }
- ]
- }
- },
"Univariate.TimeGranularity": {
"type": "string",
"enum": [
@@ -1709,22 +1611,6 @@
"isNegativeAnomaly",
"isPositiveAnomaly"
]
- },
- "Versions": {
- "type": "string",
- "enum": [
- "v1.1"
- ],
- "x-ms-enum": {
- "name": "Versions",
- "modelAsString": false,
- "values": [
- {
- "name": "v1_1",
- "value": "v1.1"
- }
- ]
- }
}
},
"parameters": {}
diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json
index 3f95581d2a85..b27e08ec3682 100644
--- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json
+++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json
@@ -3,7 +3,7 @@
"info": {
"title": "Azure OpenAI Service API",
"description": "Azure OpenAI APIs for completions and search",
- "version": "2022-03-01-preview"
+ "version": "2022-06-01-preview"
},
"servers": [
{
@@ -47,7 +47,7 @@
"required": true,
"schema": {
"type": "string",
- "example": "2022-03-01-preview",
+ "example": "2022-06-01-preview",
"description": "api version"
}
}
diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json
index 66b01d6c35c1..490205391f67 100644
--- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json
+++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json
@@ -3,7 +3,7 @@
"info": {
"title": "Azure OpenAI Service API",
"description": "Azure OpenAI APIs for completions and search",
- "version": "2022-03-01-preview"
+ "version": "2022-12-01"
},
"servers": [
{
@@ -47,7 +47,7 @@
"required": true,
"schema": {
"type": "string",
- "example": "2022-03-01-preview",
+ "example": "2022-12-01",
"description": "api version"
}
}
@@ -361,6 +361,16 @@
"example": "ada-search-index-v1"
},
"description": "The deployment id of the model which was deployed."
+ },
+ {
+ "in": "query",
+ "name": "api-version",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "2022-12-01",
+ "description": "api version"
+ }
}
],
"requestBody": {
diff --git a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json
index f5acd319c61f..4774ee8714e7 100644
--- a/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json
+++ b/specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json
@@ -2543,11 +2543,13 @@
"in": "query",
"name": "start",
"format": "uuid",
+ "description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.",
"type": "string"
},
{
"in": "query",
"name": "top",
+ "description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.",
"type": "string"
}
],
@@ -2591,6 +2593,7 @@
"in": "body",
"name": "body",
"required": true,
+ "x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/EnrollmentRequest"
}
@@ -2640,6 +2643,7 @@
{
"in": "path",
"name": "personId",
+ "description": "Person id to update.",
"required": true,
"format": "uuid",
"type": "string"
@@ -2648,6 +2652,7 @@
"in": "body",
"name": "body",
"required": true,
+ "x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/EnrollmentRequest"
}
@@ -2683,6 +2688,7 @@
{
"in": "path",
"name": "personId",
+ "description": "Person id to delete.",
"required": true,
"format": "uuid",
"type": "string"
@@ -3023,8 +3029,9 @@
{
"in": "body",
"name": "body",
- "description": "Target person face id to update.",
+ "description": "Target person face to update.",
"required": true,
+ "x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/PersistedFaceWithType"
}
@@ -3074,6 +3081,7 @@
"name": "body",
"description": "",
"required": true,
+ "x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/DynamicPersonGroupCreateRequest"
}
@@ -3130,6 +3138,7 @@
"name": "body",
"description": "",
"required": true,
+ "x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/DynamicPersonGroupUpdateRequest"
}
@@ -5253,13 +5262,16 @@
"personId": {
"format": "uuid",
"type": "string",
+ "description": "Person id.",
"x-nullable": false
},
"name": {
- "type": "string"
+ "type": "string",
+ "description": "User defined name, maximum length is 128."
},
"userData": {
- "type": "string"
+ "type": "string",
+ "description": "User specified data. Length should not exceed 16KB."
}
}
},
@@ -5277,10 +5289,12 @@
"type": "object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "User defined name, maximum length is 128."
},
"userData": {
- "type": "string"
+ "type": "string",
+ "description": "User specified data. Length should not exceed 16KB."
}
}
},
@@ -5333,7 +5347,8 @@
"ir_detection_01",
"expression_01"
],
- "type": "string"
+ "type": "string",
+ "description": "Detection model used when extracting the face."
},
"PersistedFaceWithType": {
"type": "object",
@@ -5358,13 +5373,16 @@
"type": "object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "User defined name, maximum length is 128."
},
"userData": {
- "type": "string"
+ "type": "string",
+ "description": "User specified data. Length should not exceed 16KB."
},
"addPersonIds": {
"type": "array",
+ "description": "Person ids to add to the dynamic person group.",
"items": {
"format": "uuid",
"type": "string",
@@ -5376,25 +5394,29 @@
"DynamicPersonGroupUpdateRequest": {
"type": "object",
"properties": {
- "removePersonIds": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"name": {
- "type": "string"
+ "type": "string",
+ "description": "User defined name, maximum length is 128."
},
"userData": {
- "type": "string"
+ "type": "string",
+ "description": "User specified data. Length should not exceed 16KB."
},
"addPersonIds": {
"type": "array",
+ "description": "Person ids to add to the dynamic person group.",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
}
+ },
+ "removePersonIds": {
+ "type": "array",
+ "description": "Person ids to remove from the dynamic person group.",
+ "items": {
+ "type": "string"
+ }
}
}
},
@@ -5663,7 +5685,7 @@
"name": "returnFaceId",
"in": "query",
"x-ms-parameter-location": "method",
- "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
+ "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.",
"type": "boolean"
},
"returnFaceLandmarks": {
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
index e9323a2023b1..84e52040cbef 100644
--- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
+++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
@@ -4490,7 +4490,7 @@
"name": "returnFaceId",
"in": "query",
"x-ms-parameter-location": "method",
- "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
+ "description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.",
"type": "boolean"
},
"returnFaceLandmarks": {
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
index a51bb2fb4bc6..24e8c52517e0 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
@@ -7,6 +7,11 @@
"projectName": "proj1"
},
"responses": {
- "202": {}
+ "202": {
+ "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
+ "headers": {
+ "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2022-07-01-preview"
+ }
+ }
}
}
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
index 90ef71ff1e4f..2422206550b6 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
@@ -15,14 +15,16 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
},
{
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
"sourceKind": "file",
"contentStructureKind": "unstructured",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "surface-guide.pdf"
}
]
}
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
index 0a37b03d5f77..616abdca97ee 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
@@ -13,6 +13,18 @@
}
},
"responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "errors": [],
+ "createdDateTime": "2021-05-01T17:21:14Z",
+ "expirationDateTime": "2021-05-01T17:21:14Z",
+ "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
+ "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
+ "status": "succeeded",
+ "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2022-07-01-preview"
+ }
+ },
"202": {
"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
"headers": {
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
index c538ca978e16..d2104b728381 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
@@ -11,7 +11,8 @@
"value": {
"displayName": "source3",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
- "sourceKind": "url"
+ "sourceKind": "url",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
}
},
{
@@ -20,7 +21,8 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "refresh": true
+ "refresh": true,
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
}
},
{
@@ -28,7 +30,8 @@
"value": {
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
- "sourceKind": "file"
+ "sourceKind": "file",
+ "source": "surface-guide.pdf"
}
}
]
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json
index 144a827de3bc..534082d62fed 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-07-01-preview/questionanswering-authoring.json
@@ -1649,7 +1649,8 @@
"additionalProperties": false,
"required": [
"sourceUri",
- "sourceKind"
+ "sourceKind",
+ "source"
],
"properties": {
"displayName": {
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json
index 0b8f9891ba62..db45b79590e0 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json
@@ -43,7 +43,7 @@
]
},
{
- "aspect": "generic",
+ "aspect": "narrative",
"text": "Speaker 3 believes there are 3 remaining bugs.",
"contexts": [
{
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
index ec7bfc9e3a97..97de75ad06fd 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json
@@ -7,6 +7,11 @@
"projectName": "proj1"
},
"responses": {
- "202": {}
+ "202": {
+ "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
+ "headers": {
+ "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2022-10-01-preview"
+ }
+ }
}
}
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
index 42db04c611cb..f2963bb28371 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulGetSources.json
@@ -15,14 +15,16 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
},
{
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
"sourceKind": "file",
"contentStructureKind": "unstructured",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "surface-guide.pdf"
}
]
}
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
index e0d9b0125c41..dcf2c9b75b14 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json
@@ -11,7 +11,8 @@
"value": {
"displayName": "source3",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
- "sourceKind": "url"
+ "sourceKind": "url",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
}
},
{
@@ -20,7 +21,8 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "refresh": true
+ "refresh": true,
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
}
},
{
@@ -28,7 +30,8 @@
"value": {
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
- "sourceKind": "file"
+ "sourceKind": "file",
+ "source": "surface-guide.pdf"
}
}
]
diff --git a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json
index c069d954cb44..b5b647515286 100644
--- a/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json
+++ b/specification/cognitiveservices/data-plane/Language/preview/2022-10-01-preview/questionanswering-authoring.json
@@ -1650,7 +1650,8 @@
"additionalProperties": false,
"required": [
"sourceUri",
- "sourceKind"
+ "sourceKind",
+ "source"
],
"properties": {
"displayName": {
diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json
index f253a50354a2..66b73e73064a 100644
--- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json
+++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulDeleteProject.json
@@ -7,6 +7,11 @@
"projectName": "proj1"
},
"responses": {
- "202": {}
+ "202": {
+ "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
+ "headers": {
+ "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2021-10-01"
+ }
+ }
}
}
diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json
index 6bbeb525ab0b..53ee47466167 100644
--- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json
+++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulGetSources.json
@@ -15,14 +15,16 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
},
{
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
"sourceKind": "file",
"contentStructureKind": "unstructured",
- "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
+ "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
+ "source": "surface-guide.pdf"
}
]
}
diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
index c2d558a907c0..45e8d78214a4 100644
--- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
+++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json
@@ -13,10 +13,22 @@
}
},
"responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "errors": [],
+ "createdDateTime": "2021-05-01T17:21:14Z",
+ "expirationDateTime": "2021-05-01T17:21:14Z",
+ "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
+ "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
+ "status": "succeeded",
+ "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2021-10-01"
+ }
+ },
"202": {
"description": "A successful call results with an Operation-Location header used to check the status of the analysis job.",
"headers": {
- "Operation-Location": "job1"
+ "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01"
}
}
}
diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json
index 5854f376ceeb..c9d598a7d14b 100644
--- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json
+++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/examples/questionanswering/authoring/SuccessfulUpdateSources.json
@@ -11,7 +11,8 @@
"value": {
"displayName": "source3",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
- "sourceKind": "url"
+ "sourceKind": "url",
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
}
},
{
@@ -20,7 +21,8 @@
"displayName": "source1",
"sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
"sourceKind": "url",
- "refresh": true
+ "refresh": true,
+ "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
}
},
{
@@ -28,7 +30,8 @@
"value": {
"displayName": "source2",
"sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
- "sourceKind": "file"
+ "sourceKind": "file",
+ "source": "surface-guide.pdf"
}
}
]
diff --git a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json
index 845d81317637..278f3dc43f54 100644
--- a/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json
+++ b/specification/cognitiveservices/data-plane/Language/stable/2021-10-01/questionanswering-authoring.json
@@ -1635,7 +1635,8 @@
"additionalProperties": false,
"required": [
"sourceUri",
- "sourceKind"
+ "sourceKind",
+ "source"
],
"properties": {
"displayName": {
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/cognitiveservices.json
new file mode 100644
index 000000000000..fdf2061aefd8
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/cognitiveservices.json
@@ -0,0 +1,3889 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "CognitiveServicesManagementClient",
+ "description": "Cognitive Services Management Client",
+ "version": "2022-12-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}/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/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}/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
+ },
+ "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}/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/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"
+ }
+ }
+ }
+ },
+ "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."
+ },
+ "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"
+ },
+ "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
+ }
+ },
+ "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."
+ },
+ "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"
+ }
+ ]
+ },
+ "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."
+ },
+ "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."
+ },
+ "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": {
+ "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",
+ "description": "The Kind of the resource."
+ },
+ "type": {
+ "type": "string",
+ "description": "The Type of the resource."
+ }
+ },
+ "required": [
+ "skus",
+ "kind",
+ "type"
+ ]
+ },
+ "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
+ }
+ },
+ "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"
+ },
+ "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."
+ },
+ "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": {
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "readOnly": true
+ },
+ "etag": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Etag."
+ },
+ "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"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "model": {
+ "type": "object",
+ "$ref": "#/definitions/DeploymentModel"
+ },
+ "scaleSettings": {
+ "type": "object",
+ "$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"
+ }
+ },
+ "description": "Properties of Cognitive Services account deployment."
+ },
+ "DeploymentModel": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "type": "string",
+ "description": "Deployment model format."
+ },
+ "name": {
+ "type": "string",
+ "description": "Deployment model name."
+ },
+ "version": {
+ "type": "string",
+ "description": "Deployment model version."
+ },
+ "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."
+ },
+ "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": {
+ "type": "object",
+ "$ref": "#/definitions/CommitmentQuota"
+ },
+ "cost": {
+ "type": "object",
+ "$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": {
+ "type": "object",
+ "$ref": "#/definitions/CommitmentPeriod"
+ },
+ "autoRenew": {
+ "type": "boolean",
+ "description": "AutoRenew commitment plan."
+ },
+ "next": {
+ "type": "object",
+ "$ref": "#/definitions/CommitmentPeriod"
+ },
+ "last": {
+ "type": "object",
+ "$ref": "#/definitions/CommitmentPeriod",
+ "readOnly": true
+ }
+ },
+ "description": "Properties of Cognitive Services account commitment plan."
+ },
+ "HostingModel": {
+ "type": "string",
+ "description": "Account hosting model.",
+ "enum": [
+ "Web",
+ "ConnectedContainer",
+ "DisconnectedContainer"
+ ],
+ "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": {
+ "type": "object",
+ "$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."
+ },
+ "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": {
+ "type": "object",
+ "description": "Base Model Identifier.",
+ "$ref": "#/definitions/DeploymentModel"
+ },
+ "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": {
+ "type": "object",
+ "$ref": "#/definitions/ModelDeprecationInfo"
+ },
+ "lifecycleStatus": {
+ "type": "string",
+ "enum": [
+ "GenerallyAvailable",
+ "Preview"
+ ],
+ "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."
+ }
+ }
+ },
+ "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"
+ }
+ ]
+ }
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CheckDomainAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CheckDomainAvailability.json
new file mode 100644
index 000000000000..2f62b6b63cbe
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CheckDomainAvailability.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/CheckSkuAvailability.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CheckSkuAvailability.json
new file mode 100644
index 000000000000..cafed6a9605e
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CheckSkuAvailability.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/CreateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateAccount.json
new file mode 100644
index 000000000000..cf3ac999caed
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateAccount.json
@@ -0,0 +1,140 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/CreateAccountMin.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateAccountMin.json
new file mode 100644
index 000000000000..8aa03c2336cb
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateAccountMin.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/CreateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateSharedCommitmentPlan.json
new file mode 100644
index 000000000000..a4622a1368b7
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateSharedCommitmentPlan.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/CreateSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateSharedCommitmentPlanAssociation.json
new file mode 100644
index 000000000000..020c7f75f1a8
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/CreateSharedCommitmentPlanAssociation.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/DeleteAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteAccount.json
new file mode 100644
index 000000000000..29d834fe9bf0
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteAccount.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/DeleteCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteCommitmentPlan.json
new file mode 100644
index 000000000000..2e2d2fe31dd0
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteCommitmentPlan.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/DeleteDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteDeployment.json
new file mode 100644
index 000000000000..3e250f01ec80
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteDeployment.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/DeletePrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..140b67a72a2c
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeletePrivateEndpointConnection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-12-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/2022-12-01/examples/DeleteSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteSharedCommitmentPlan.json
new file mode 100644
index 000000000000..266853a1a030
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteSharedCommitmentPlan.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/DeleteSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteSharedCommitmentPlanAssociation.json
new file mode 100644
index 000000000000..673c5a735002
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/DeleteSharedCommitmentPlanAssociation.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetAccount.json
new file mode 100644
index 000000000000..569865499f4a
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetAccount.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetCommitmentPlan.json
new file mode 100644
index 000000000000..b9600bd26862
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetCommitmentPlan.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetDeletedAccount.json
new file mode 100644
index 000000000000..f979b8c58a96
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetDeletedAccount.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetDeployment.json
new file mode 100644
index 000000000000..5784a83a7e3e
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetDeployment.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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",
+ "properties": {
+ "model": {
+ "format": "OpenAI",
+ "name": "ada",
+ "version": "1"
+ },
+ "scaleSettings": {
+ "scaleType": "Manual",
+ "capacity": 1
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetOperations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetOperations.json
new file mode 100644
index 000000000000..18c809043284
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetOperations.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..fbcc575f3195
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetPrivateEndpointConnection.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-12-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/2022-12-01/examples/GetSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSharedCommitmentPlan.json
new file mode 100644
index 000000000000..f4f7870aeccd
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSharedCommitmentPlan.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetSharedCommitmentPlanAssociation.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSharedCommitmentPlanAssociation.json
new file mode 100644
index 000000000000..29778d7e5109
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSharedCommitmentPlanAssociation.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSkus.json
new file mode 100644
index 000000000000..d660cdf3981f
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetSkus.json
@@ -0,0 +1,2164 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/GetUsages.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetUsages.json
new file mode 100644
index 000000000000..20dcf4f5d4f7
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/GetUsages.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListAccountModels.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountModels.json
new file mode 100644
index 000000000000..ba662ec49607
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountModels.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListAccountsByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountsByResourceGroup.json
new file mode 100644
index 000000000000..c4c654691cf6
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountsByResourceGroup.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountsBySubscription.json
new file mode 100644
index 000000000000..16bcaee84e97
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListAccountsBySubscription.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListCommitmentPlans.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListCommitmentPlans.json
new file mode 100644
index 000000000000..853f84eac93b
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListCommitmentPlans.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListCommitmentTiers.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListCommitmentTiers.json
new file mode 100644
index 000000000000..6dec7a94d5e0
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListCommitmentTiers.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListDeletedAccountsBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListDeletedAccountsBySubscription.json
new file mode 100644
index 000000000000..16bcaee84e97
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListDeletedAccountsBySubscription.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListDeployments.json
new file mode 100644
index 000000000000..c348e041cc28
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListDeployments.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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",
+ "properties": {
+ "model": {
+ "format": "OpenAI",
+ "name": "ada",
+ "version": "1"
+ },
+ "scaleSettings": {
+ "scaleType": "Manual",
+ "capacity": 1
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListKeys.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListKeys.json
new file mode 100644
index 000000000000..4482319c5e05
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListKeys.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListPrivateEndpointConnections.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..8126dd8a1010
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListPrivateEndpointConnections.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "api-version": "2022-12-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/2022-12-01/examples/ListPrivateLinkResources.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListPrivateLinkResources.json
new file mode 100644
index 000000000000..421a99987da7
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res6977",
+ "accountName": "sto2527",
+ "api-version": "2022-12-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/2022-12-01/examples/ListSharedCommitmentPlanAssociations.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlanAssociations.json
new file mode 100644
index 000000000000..5fc3d5bbb0c9
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlanAssociations.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListSharedCommitmentPlansByResourceGroup.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlansByResourceGroup.json
new file mode 100644
index 000000000000..beed6fbfc76a
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlansByResourceGroup.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListSharedCommitmentPlansBySubscription.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlansBySubscription.json
new file mode 100644
index 000000000000..5a33e915c89e
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSharedCommitmentPlansBySubscription.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/ListSkus.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSkus.json
new file mode 100644
index 000000000000..1e146a07927f
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/ListSkus.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/PurgeDeletedAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PurgeDeletedAccount.json
new file mode 100644
index 000000000000..2eb14e187e2c
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PurgeDeletedAccount.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/PutCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutCommitmentPlan.json
new file mode 100644
index 000000000000..cb17e5a6eda6
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutCommitmentPlan.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/PutDeployment.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutDeployment.json
new file mode 100644
index 000000000000..0315f3a593bb
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutDeployment.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "subscriptionId",
+ "resourceGroupName": "resourceGroupName",
+ "accountName": "accountName",
+ "deploymentName": "deploymentName",
+ "deployment": {
+ "properties": {
+ "model": {
+ "format": "OpenAI",
+ "name": "ada",
+ "version": "1"
+ },
+ "scaleSettings": {
+ "scaleType": "Manual",
+ "capacity": 1
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
+ "name": "deploymentName",
+ "type": "Microsoft.CognitiveServices/accounts/deployments",
+ "properties": {
+ "model": {
+ "format": "OpenAI",
+ "name": "ada",
+ "version": "1"
+ },
+ "scaleSettings": {
+ "scaleType": "Manual",
+ "capacity": 1
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName",
+ "name": "deploymentName",
+ "type": "Microsoft.CognitiveServices/accounts/deployments",
+ "properties": {
+ "model": {
+ "format": "OpenAI",
+ "name": "ada",
+ "version": "1"
+ },
+ "scaleSettings": {
+ "scaleType": "Manual",
+ "capacity": 1
+ },
+ "provisioningState": "Accepted"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutPrivateEndpointConnection.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutPrivateEndpointConnection.json
new file mode 100644
index 000000000000..1945526048e8
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/PutPrivateEndpointConnection.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "res7687",
+ "accountName": "sto9699",
+ "privateEndpointConnectionName": "{privateEndpointConnectionName}",
+ "api-version": "2022-12-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/2022-12-01/examples/RegenerateKey.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/RegenerateKey.json
new file mode 100644
index 000000000000..9811666ea6d9
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/RegenerateKey.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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/2022-12-01/examples/UpdateAccount.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/UpdateAccount.json
new file mode 100644
index 000000000000..a62790cc4564
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/UpdateAccount.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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=2022-12-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=2022-12-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/2022-12-01/examples/UpdateSharedCommitmentPlan.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/UpdateSharedCommitmentPlan.json
new file mode 100644
index 000000000000..d9ad4ae9ed57
--- /dev/null
+++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2022-12-01/examples/UpdateSharedCommitmentPlan.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2022-12-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 33bf9a04bc19..136c6834d1ca 100644
--- a/specification/cognitiveservices/resource-manager/readme.md
+++ b/specification/cognitiveservices/resource-manager/readme.md
@@ -30,18 +30,27 @@ These are the global settings for the CognitiveServices API.
``` yaml
openapi-type: arm
-tag: package-2022-10
+tag: package-2022-12
```
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.CognitiveServices/stable/2022-12-01/cognitiveservices.json
+```
### Tag: package-2022-10
These settings apply only when `--tag=package-2022-10` is specified on the command line.
-```yaml $(tag) == 'package-2022-10'
+``` yaml $(tag) == 'package-2022-10'
input-file:
- Microsoft.CognitiveServices/stable/2022-10-01/cognitiveservices.json
```
+
### Tag: package-2022-03
These settings apply only when `--tag=package-2022-03` is specified on the command line.
@@ -87,6 +96,15 @@ input-file:
- Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json
```
+## Suppression
+``` yaml
+directive:
+ - suppress: TrackedResourcePatchOperation
+ from: cognitiveservices.json
+ where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/commitmentPlans/{commitmentPlanName}"]
+ reason: The resource accounts/commitmentPlans is not a tracked resource
+```
+
---
# Code Generation
diff --git a/specification/common-types/resource-management/v4/customermanagedkeys.json b/specification/common-types/resource-management/v4/customermanagedkeys.json
index d403a8e2c035..a9be420dcaad 100644
--- a/specification/common-types/resource-management/v4/customermanagedkeys.json
+++ b/specification/common-types/resource-management/v4/customermanagedkeys.json
@@ -51,7 +51,6 @@
},
"userAssignedIdentityResourceId": {
"type": "string",
- "format": "arm-id",
"description": "user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and delegatedResourceIdentity."
},
"delegatedIdentityClientId": {
diff --git a/specification/common-types/resource-management/v4/types.json b/specification/common-types/resource-management/v4/types.json
index 84303a33cc90..158f9cea8196 100644
--- a/specification/common-types/resource-management/v4/types.json
+++ b/specification/common-types/resource-management/v4/types.json
@@ -14,7 +14,6 @@
"id": {
"readOnly": true,
"type": "string",
- "format": "arm-id",
"description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
},
"name": {
@@ -649,6 +648,36 @@
"maxLength": 90,
"x-ms-parameter-location": "method"
},
+ "ManagementGroupNameParameter": {
+ "name": "managementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the management group. The name is case insensitive.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "ScopeParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The scope at which the operation is performed.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
+ },
+ "TenantIdParameter": {
+ "name": "tenantId",
+ "in": "path",
+ "description": "The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-ms-parameter-location": "method"
+ },
"OperationIdParameter": {
"name": "operationId",
"in": "path",
@@ -663,9 +692,25 @@
"in": "path",
"required": true,
"type": "string",
- "description": "The name of Azure region.",
+ "description": "The name of the Azure region.",
"minLength": 1,
"x-ms-parameter-location": "method"
+ },
+ "If-Match": {
+ "name": "ifMatch",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "The If-Match header that makes a request conditional.",
+ "x-ms-parameter-location": "method"
+ },
+ "If-None-Match": {
+ "name": "ifNoneMatch",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "The If-None-Match header that makes a request conditional.",
+ "x-ms-parameter-location": "method"
}
}
}
diff --git a/specification/common-types/resource-management/v5/types.json b/specification/common-types/resource-management/v5/types.json
new file mode 100644
index 000000000000..547145643bcf
--- /dev/null
+++ b/specification/common-types/resource-management/v5/types.json
@@ -0,0 +1,721 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "4.0",
+ "title": "Common types"
+ },
+ "paths": {},
+ "definitions": {
+ "Resource": {
+ "title": "Resource",
+ "description": "Common fields that are returned in the response for all Azure Resource Manager resources",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
+ },
+ "systemData": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "AzureEntityResource": {
+ "x-ms-client-name": "AzureEntityResource",
+ "title": "Entity Resource",
+ "description": "The resource model definition for an Azure Resource Manager resource with an etag.",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Etag."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "TrackedResource": {
+ "title": "Tracked Resource",
+ "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "ProxyResource": {
+ "title": "Proxy Resource",
+ "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "ResourceModelWithAllowedPropertySet": {
+ "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.",
+ "type": "object",
+ "properties": {
+ "managedBy": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource."
+ },
+ "kind": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
+ },
+ "etag": {
+ "readOnly": true,
+ "type": "string",
+ "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. 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. "
+ },
+ "identity": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Identity"
+ }
+ ]
+ },
+ "sku": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Sku"
+ }
+ ]
+ },
+ "plan": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/Plan"
+ }
+ ]
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "x-ms-azure-resource": true
+ },
+ "SkuTier": {
+ "type": "string",
+ "enum": [
+ "Free",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": false
+ },
+ "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."
+ },
+ "Sku": {
+ "description": "The resource model definition representing SKU",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the SKU. E.g. P3. It is typically a letter+number code"
+ },
+ "tier": {
+ "$ref": "#/definitions/SkuTier"
+ },
+ "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"
+ ]
+ },
+ "Identity": {
+ "description": "Identity for the resource.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "format": "uuid",
+ "description": "The principal ID of resource identity. The value must be an UUID."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "format": "uuid",
+ "description": "The tenant ID of resource. The value must be an UUID."
+ },
+ "type": {
+ "type": "string",
+ "description": "The identity type.",
+ "enum": [
+ "SystemAssigned"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "Plan": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "A user defined name of the 3rd Party Artifact that is being procured."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic"
+ },
+ "product": {
+ "type": "string",
+ "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. "
+ },
+ "promotionCode": {
+ "type": "string",
+ "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact."
+ },
+ "version": {
+ "type": "string",
+ "description": "The version of the desired product/artifact."
+ }
+ },
+ "description": "Plan for the resource.",
+ "required": [
+ "name",
+ "publisher",
+ "product"
+ ]
+ },
+ "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."
+ }
+ }
+ },
+ "ErrorResponse": {
+ "title": "Error response",
+ "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error object.",
+ "$ref": "#/definitions/ErrorDetail"
+ }
+ }
+ },
+ "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."
+ },
+ "Operation": {
+ "title": "REST API Operation",
+ "description": "Details of a REST API operation, returned from the Resource Provider Operations API",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDataAction": {
+ "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "display": {
+ "description": "Localized display information for this particular operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
+ "type": "string",
+ "readOnly": true
+ },
+ "resource": {
+ "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
+ "type": "string",
+ "readOnly": true
+ },
+ "operation": {
+ "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "origin": {
+ "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"",
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "user",
+ "system",
+ "user,system"
+ ],
+ "x-ms-enum": {
+ "name": "Origin",
+ "modelAsString": true
+ }
+ },
+ "actionType": {
+ "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.",
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "Internal"
+ ],
+ "x-ms-enum": {
+ "name": "ActionType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "List of operations supported by the resource provider",
+ "readOnly": true
+ },
+ "nextLink": {
+ "type": "string",
+ "format": "uri",
+ "description": "URL to get the next set of operation list results (if there are any).",
+ "readOnly": true
+ }
+ }
+ },
+ "OperationStatusResult": {
+ "description": "The current status of an async operation.",
+ "type": "object",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "id": {
+ "description": "Fully qualified ID for the async operation.",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "Fully qualified ID of the resource against which the original async operation was started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of the async operation.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Operation status.",
+ "type": "string"
+ },
+ "percentComplete": {
+ "description": "Percent of the operation that is complete.",
+ "type": "number",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "startTime": {
+ "description": "The start time of the operation.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "endTime": {
+ "description": "The end time of the operation.",
+ "type": "string",
+ "format": "date-time"
+ },
+ "operations": {
+ "description": "The operations list.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationStatusResult"
+ }
+ },
+ "error": {
+ "description": "If present, details of the operation error.",
+ "$ref": "#/definitions/ErrorDetail"
+ }
+ }
+ },
+ "locationData": {
+ "description": "Metadata pertaining to the geographic location of the resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 256,
+ "description": "A canonical name for the geographic or physical location."
+ },
+ "city": {
+ "type": "string",
+ "description": "The city or locality where the resource is located."
+ },
+ "district": {
+ "type": "string",
+ "description": "The district, state, or province where the resource is located."
+ },
+ "countryOrRegion": {
+ "type": "string",
+ "description": "The country or region where the resource is located"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "systemData": {
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "createdBy": {
+ "type": "string",
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": "string",
+ "description": "The type of identity that created the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": "string",
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": "string",
+ "description": "The type of identity that last modified the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "lastModifiedAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of resource last modification (UTC)"
+ }
+ }
+ },
+ "encryptionProperties": {
+ "description": "Configuration of key for data encryption",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the encryption is enabled for container registry.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EncryptionStatus",
+ "modelAsString": true
+ }
+ },
+ "keyVaultProperties": {
+ "$ref": "#/definitions/KeyVaultProperties",
+ "description": "Key vault properties."
+ }
+ }
+ },
+ "KeyVaultProperties": {
+ "type": "object",
+ "properties": {
+ "keyIdentifier": {
+ "description": "Key vault uri to access the encryption key.",
+ "type": "string"
+ },
+ "identity": {
+ "description": "The client ID of the identity which will be used to access key vault.",
+ "type": "string"
+ }
+ }
+ },
+ "CheckNameAvailabilityRequest": {
+ "description": "The check availability request body.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the resource for which availability needs to be checked.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The resource type.",
+ "type": "string"
+ }
+ }
+ },
+ "CheckNameAvailabilityResponse": {
+ "description": "The check availability result.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "Indicates if the resource name is available.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "The reason why the given name is not available.",
+ "type": "string",
+ "enum": [
+ "Invalid",
+ "AlreadyExists"
+ ],
+ "x-ms-enum": {
+ "name": "CheckNameAvailabilityReason",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "Detailed reason why the given name is available.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "description": "The ID of the target subscription. The value must be an UUID."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation.",
+ "minLength": 1
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "ManagementGroupNameParameter": {
+ "name": "managementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the management group. The name is case insensitive.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "ScopeParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The scope at which the operation is performed.",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
+ },
+ "TenantIdParameter": {
+ "name": "tenantId",
+ "in": "path",
+ "description": "The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)",
+ "required": true,
+ "type": "string",
+ "format": "uuid",
+ "x-ms-parameter-location": "method"
+ },
+ "OperationIdParameter": {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of an ongoing async operation.",
+ "minLength": 1,
+ "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"
+ },
+ "If-Match": {
+ "name": "ifMatch",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "The If-Match header that makes a request conditional.",
+ "x-ms-parameter-location": "method"
+ },
+ "If-None-Match": {
+ "name": "ifNoneMatch",
+ "in": "header",
+ "required": true,
+ "type": "string",
+ "description": "The If-None-Match header that makes a request conditional.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json
new file mode 100644
index 000000000000..5938fea4e2bb
--- /dev/null
+++ b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/communicationservicessiprouting.json
@@ -0,0 +1,567 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "SipRouting Service",
+ "description": "SipRouting Service",
+ "contact": {
+ "email": "acsdevexdisc@microsoft.com"
+ },
+ "version": "2023-01-01-preview"
+ },
+ "paths": {
+ "/sip": {
+ "get": {
+ "tags": [
+ "SipConfiguration"
+ ],
+ "summary": "Gets SIP configuration for resource.",
+ "operationId": "SipRouting_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ExpandSipConfiguration"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok.",
+ "schema": {
+ "$ref": "#/definitions/SipConfiguration"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
+ },
+ "headers": {
+ "x-ms-error-code": {
+ "type": "string",
+ "description": "Error code"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get SIP configuration for resource": {
+ "$ref": "./examples/GetSipConfiguration.json"
+ },
+ "Get SIP configuration for resource with Trunk Health expand": {
+ "$ref": "./examples/GetSipConfigurationWithExpand.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SipConfiguration"
+ ],
+ "summary": "Patches SIP configuration for resource.",
+ "operationId": "SipRouting_Patch",
+ "consumes": [
+ "application/merge-patch+json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "body",
+ "description": "Sip configuration patch object.",
+ "schema": {
+ "$ref": "#/definitions/SipConfigurationPatch"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Patched configuration is returned.",
+ "schema": {
+ "$ref": "#/definitions/SipConfiguration"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
+ },
+ "headers": {
+ "x-ms-error-code": {
+ "type": "string",
+ "description": "Error code"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch SIP configuration for resource": {
+ "$ref": "./examples/PatchSipConfiguration.json"
+ }
+ }
+ }
+ },
+ "/sip:testRoutesWithNumber": {
+ "post": {
+ "tags": [
+ "NumberRoutingValidation"
+ ],
+ "summary": "Gets the list of routes matching the target phone number, ordered by priority.",
+ "operationId": "SipRouting_TestRoutesWithNumber",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "targetPhoneNumber",
+ "description": "Phone number to test routing patterns against",
+ "required": true,
+ "type": "string",
+ "x-example": "+11234567890"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "in": "body",
+ "name": "sipConfiguration",
+ "description": "Sip configuration object to test with targetPhoneNumber.",
+ "schema": {
+ "$ref": "#/definitions/SipConfiguration"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of matching routes",
+ "schema": {
+ "$ref": "#/definitions/RoutesForNumber"
+ }
+ },
+ "default": {
+ "description": "Failure",
+ "schema": {
+ "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse"
+ },
+ "x-ms-error-response": true
+ }
+ },
+ "x-ms-examples": {
+ "Validate target phone number routing": {
+ "$ref": "./examples/TestRoutesWithNumber.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Trunk": {
+ "description": "Represents a SIP trunk for routing calls. See RFC 4904. Can be expanded with additional data.",
+ "required": [
+ "sipSignalingPort",
+ "enabled"
+ ],
+ "type": "object",
+ "properties": {
+ "sipSignalingPort": {
+ "format": "int32",
+ "description": "Gets or sets SIP signaling port of the trunk.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "Enabled flag",
+ "$ref": "#/definitions/Enabled"
+ },
+ "health": {
+ "description": "Represents health state of a SIP trunk for routing calls.",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "#/definitions/Health"
+ }
+ }
+ },
+ "Health": {
+ "description": "Represents health state of a SIP trunk for routing calls.",
+ "type": "object",
+ "required": [
+ "tls",
+ "ping",
+ "overall"
+ ],
+ "properties": {
+ "tls": {
+ "$ref": "#/definitions/Tls"
+ },
+ "ping": {
+ "$ref": "#/definitions/Ping"
+ },
+ "overall": {
+ "$ref": "#/definitions/OverallHealth"
+ }
+ }
+ },
+ "Tls": {
+ "type": "object",
+ "description": "The status of the TLS connections of the Trunk.",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The status of the TLS connections of the Trunk.",
+ "enum": [
+ "unknown",
+ "ok",
+ "certExpiring",
+ "certExpired"
+ ],
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "tlsStatus",
+ "values": [
+ {
+ "value": "unknown",
+ "description": "Indicates an unknown status."
+ },
+ {
+ "value": "ok",
+ "description": "Indicates the status is okay."
+ },
+ {
+ "value": "certExpiring",
+ "description": "Indicates the Trunk certificate is expiring."
+ },
+ {
+ "value": "certExpired",
+ "description": "Indicates the Trunk certificate is expired."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "Ping": {
+ "type": "object",
+ "description": "The status of SIP OPTIONS message sent by Trunk.",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The status of SIP OPTIONS message sent by Trunk.",
+ "enum": [
+ "unknown",
+ "ok",
+ "expired",
+ "error"
+ ],
+ "x-ms-enum": {
+ "name": "pingStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "unknown",
+ "description": "Indicates an unknown status."
+ },
+ {
+ "value": "ok",
+ "description": "Indicates the status is okay."
+ },
+ {
+ "value": "expired",
+ "description": "Indicates the status is expired."
+ },
+ {
+ "value": "error",
+ "description": "Indicates the status is at an error level."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "OverallHealth": {
+ "type": "object",
+ "description": "The overall health status of Trunk.",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The overall health status of Trunk.",
+ "enum": [
+ "unknown",
+ "active",
+ "inactive"
+ ],
+ "x-ms-enum": {
+ "name": "overallHealthStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "unknown",
+ "description": "Indicates an unknown health status."
+ },
+ {
+ "value": "active",
+ "description": "Indicates the Trunk is active."
+ },
+ {
+ "value": "inactive",
+ "description": "Indicates the Trunk is inactive."
+ }
+ ]
+ }
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason overall status of Trunk is inactive.",
+ "enum": [
+ "noRecentCalls",
+ "noRecentPings",
+ "noRecentCallsAndPings"
+ ],
+ "x-ms-enum": {
+ "name": "inactiveStatusReason",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "noRecentCalls",
+ "description": "Indicates no recent calls."
+ },
+ {
+ "value": "noRecentPings",
+ "description": "Indicates ping status is expired."
+ },
+ {
+ "value": "noRecentCallsAndPings",
+ "description": "Indicates no recent calls and ping status is expired."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "TrunkPatch": {
+ "description": "Represents a SIP trunk patch.",
+ "type": "object",
+ "properties": {
+ "sipSignalingPort": {
+ "format": "int32",
+ "description": "Gets or sets SIP signaling port of the trunk.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "Enabled flag",
+ "$ref": "#/definitions/Enabled"
+ }
+ }
+ },
+ "TrunkRoute": {
+ "description": "Represents a trunk route for routing calls.",
+ "required": [
+ "name",
+ "numberPattern"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Gets or sets description of the route.",
+ "maxLength": 1024,
+ "type": "string"
+ },
+ "name": {
+ "description": "Gets or sets name of the route.",
+ "maxLength": 256,
+ "type": "string"
+ },
+ "numberPattern": {
+ "description": "Gets or sets regex number pattern for routing calls. .NET regex format is supported.\r\nThe regex should match only digits with an optional '+' prefix without spaces.\r\nI.e. \"^\\+[1-9][0-9]{3,23}$\".",
+ "maxLength": 1024,
+ "type": "string"
+ },
+ "trunks": {
+ "description": "Gets or sets list of SIP trunks for routing calls. Trunks are represented as FQDN.",
+ "maxItems": 250,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Enabled": {
+ "type": "boolean",
+ "description": "Flag if domain is enabled or not.\r\nIf enabled it's used in configuration, if not enabled it's not used."
+ },
+ "Domain": {
+ "description": "Represents Domain object as response of validation api.\r\nMap key is domain.",
+ "required": [
+ "enabled"
+ ],
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Enabled flag",
+ "$ref": "#/definitions/Enabled"
+ }
+ }
+ },
+ "SipConfiguration": {
+ "description": "Represents a SIP configuration.\r\nWhen a call is being routed the routes are applied in the same order as in the routes list.\r\nA route is matched by its number pattern.\r\nCall is then directed into route's first available trunk, based on the order in the route's trunks list. The configuration can be expanded with additional data.",
+ "type": "object",
+ "properties": {
+ "domains": {
+ "description": "Validated Domains.\r\nMap key is domain.",
+ "maxProperties": 250,
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "trunks": {
+ "description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).",
+ "maxProperties": 250,
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/Trunk"
+ }
+ },
+ "routes": {
+ "description": "Trunk routes for routing calls.",
+ "maxItems": 250,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrunkRoute"
+ }
+ }
+ }
+ },
+ "DomainPatch": {
+ "description": "Represents Domain that will be validated and used.\r\nMap key is domain.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Enabled flag",
+ "$ref": "#/definitions/Enabled"
+ }
+ }
+ },
+ "SipConfigurationPatch": {
+ "description": "Represents a SIP configuration patch.",
+ "type": "object",
+ "properties": {
+ "domains": {
+ "description": "Domains that will be validated and used.\r\nMap key is domain.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/DomainPatch"
+ }
+ },
+ "trunks": {
+ "description": "SIP trunks for routing calls.\r\nMap key is trunk's FQDN (1-249 characters).",
+ "maxProperties": 250,
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/TrunkPatch"
+ }
+ },
+ "routes": {
+ "description": "Trunk routes for routing calls.",
+ "maxItems": 250,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrunkRoute"
+ }
+ }
+ }
+ },
+ "RoutesForNumber": {
+ "description": "Represents number routing validation details.",
+ "type": "object",
+ "properties": {
+ "matchingRoutes": {
+ "description": "The list of routes whose number patterns are matched by the target number. The routes are displayed and apply in the same order as in SipConfiguration.",
+ "maxItems": 250,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrunkRoute"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ExpandSipConfiguration": {
+ "name": "expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Sip configuration expand. Optional.",
+ "x-ms-parameter-location": "method",
+ "enum": [
+ "trunks/health"
+ ],
+ "x-ms-enum": {
+ "name": "ExpandEnum",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "trunks/health",
+ "description": "Health state of a SIP trunk for routing calls."
+ }
+ ]
+ }
+ },
+ "ApiVersionParameter": {
+ "in": "query",
+ "name": "api-version",
+ "description": "Version of API to invoke",
+ "required": true,
+ "type": "string"
+ },
+ "Endpoint": {
+ "in": "path",
+ "name": "endpoint",
+ "description": "The communication resource, for example https://resourcename.communication.azure.com",
+ "required": true,
+ "type": "string",
+ "x-ms-skip-url-encoding": true,
+ "x-ms-parameter-location": "client"
+ }
+ },
+ "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"
+ }
+ },
+ "x-ms-parameterized-host": {
+ "hostTemplate": "{endpoint}",
+ "useSchemePrefix": false,
+ "parameters": [
+ {
+ "$ref": "#/parameters/Endpoint"
+ }
+ ]
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfiguration.json b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfiguration.json
new file mode 100644
index 000000000000..cabb93392708
--- /dev/null
+++ b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfiguration.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "endpoint": "https://resourcename.communication.azure.com/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "domains": {
+ "xyz.biz": {
+ "enabled": true
+ },
+ "abc.biz": {
+ "enabled": true
+ }
+ },
+ "trunks": {
+ "vendor.xyz.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true
+ },
+ "vendor.abc.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true
+ }
+ },
+ "routes": [
+ {
+ "name": "LocalRoute",
+ "numberPattern": "^\\+1[0-9]{10}$"
+ },
+ {
+ "name": "VendorXYZ",
+ "description": "External route XYZ",
+ "numberPattern": "^\\+?\\d+$",
+ "trunks": [
+ "vendor.xyz.biz"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfigurationWithExpand.json b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfigurationWithExpand.json
new file mode 100644
index 000000000000..70a1921579f5
--- /dev/null
+++ b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/GetSipConfigurationWithExpand.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "endpoint": "https://resourcename.communication.azure.com/",
+ "expand": "trunks/health"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "domains": {
+ "xyz.biz": {
+ "enabled": true
+ },
+ "abc.biz": {
+ "enabled": true
+ }
+ },
+ "trunks": {
+ "vendor.xyz.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true,
+ "health": {
+ "tls": {
+ "status": "unknown"
+ },
+ "ping": {
+ "status": "unknown"
+ },
+ "overall": {
+ "status": "unknown"
+ }
+ }
+ },
+ "vendor.abc.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true,
+ "health": {
+ "tls": {
+ "status": "certExpiring"
+ },
+ "ping": {
+ "status": "ok"
+ },
+ "overall": {
+ "status": "inactive",
+ "reason": "noRecentCalls"
+ }
+ }
+ }
+ },
+ "routes": [
+ {
+ "name": "LocalRoute",
+ "numberPattern": "^\\+1[0-9]{10}$"
+ },
+ {
+ "name": "VendorXYZ",
+ "description": "External route XYZ",
+ "numberPattern": "^\\+?\\d+$",
+ "trunks": [
+ "vendor.xyz.biz"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/PatchSipConfiguration.json b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/PatchSipConfiguration.json
new file mode 100644
index 000000000000..f14bb5b00b62
--- /dev/null
+++ b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/PatchSipConfiguration.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "domains": {
+ "xyz.biz": {
+ "type": "Custom"
+ }
+ },
+ "body": {
+ "domains": {
+ "xyz.biz": {
+ "enabled": true
+ },
+ "abc.biz": {
+ "enabled": true
+ }
+ },
+ "trunks": {
+ "vendor.xyz.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true
+ }
+ },
+ "routes": [
+ {
+ "name": "VendorXYZ",
+ "description": "External route XYZ",
+ "numberPattern": "^\\+?\\d+$",
+ "trunks": [
+ "vendor.xyz.biz"
+ ]
+ }
+ ]
+ },
+ "endpoint": "https://resourcename.communication.azure.com/"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "domains": {
+ "xyz.biz": {
+ "enabled": true
+ },
+ "abc.biz": {
+ "enabled": true
+ }
+ },
+ "trunks": {
+ "vendor.xyz.biz": {
+ "sipSignalingPort": 5061,
+ "enabled": true
+ }
+ },
+ "routes": [
+ {
+ "name": "VendorXYZ",
+ "description": "External route XYZ",
+ "numberPattern": "^\\+?\\d+$",
+ "trunks": [
+ "vendor.xyz.biz"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/TestRoutesWithNumber.json b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/TestRoutesWithNumber.json
new file mode 100644
index 000000000000..4f61495cff7f
--- /dev/null
+++ b/specification/communication/data-plane/SipRouting/preview/2023-01-01-preview/examples/TestRoutesWithNumber.json
@@ -0,0 +1,105 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "endpoint": "https://resourcename.communication.azure.com/",
+ "targetPhoneNumber": "+14251234567",
+ "sipConfiguration": {
+ "domains": {
+ "contoso.com": {
+ "enabled": true
+ }
+ },
+ "trunks": {
+ "seattle.contoso.com": {
+ "sipSignalingPort": 5011,
+ "enabled": true
+ },
+ "us1.contoso.com": {
+ "sipSignalingPort": 5012,
+ "enabled": true
+ },
+ "us2.contoso.com": {
+ "sipSignalingPort": 5013,
+ "enabled": true
+ },
+ "russia.contoso.com": {
+ "sipSignalingPort": 5014,
+ "enabled": true
+ },
+ "global.contoso.com": {
+ "sipSignalingPort": 5015,
+ "enabled": true
+ }
+ },
+ "routes": [
+ {
+ "name": "Seattle",
+ "description": "Seattle route",
+ "numberPattern": "^\\+1(425|206)\\d{7}$",
+ "trunks": [
+ "seattle.contoso.com"
+ ]
+ },
+ {
+ "name": "US",
+ "description": "US route",
+ "numberPattern": "^\\+1\\d{10}$",
+ "trunks": [
+ "us1.contoso.com",
+ "us2.contoso.com"
+ ]
+ },
+ {
+ "name": "Russia",
+ "description": "Russian route",
+ "numberPattern": "^\\+7\\d+$",
+ "trunks": [
+ "russia.contoso.com"
+ ]
+ },
+ {
+ "name": "Global",
+ "description": "Fallback route",
+ "numberPattern": "^\\+\\d+$",
+ "trunks": [
+ "global.contoso.com"
+ ]
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "matchingRoutes": [
+ {
+ "description": "Seattle route",
+ "name": "Seattle",
+ "numberPattern": "^\\+1(425|206)\\d{7}$",
+ "trunks": [
+ "seattle.contoso.com"
+ ]
+ },
+ {
+ "description": "US route",
+ "name": "US",
+ "numberPattern": "^\\+1\\d{10}$",
+ "trunks": [
+ "us1.contoso.com",
+ "us2.contoso.com"
+ ]
+ },
+ {
+ "description": "Fallback route",
+ "name": "Global",
+ "numberPattern": "^\\+\\d+$",
+ "trunks": [
+ "global.contoso.com"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/communication/data-plane/SipRouting/readme.md b/specification/communication/data-plane/SipRouting/readme.md
index 950f734e7bbc..6c53bf4e1710 100644
--- a/specification/communication/data-plane/SipRouting/readme.md
+++ b/specification/communication/data-plane/SipRouting/readme.md
@@ -26,7 +26,18 @@ These are the global settings for the communicationservices.
```yaml
openapi-type: data-plane
-tag: package-2022-10-01-preview
+tag: package-2023-01-01-preview
+```
+
+### Tag: package-2023-01-01-preview
+
+These settings apply only when `--tag=package-2023-01-01-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2023-01-01-preview'
+input-file:
+ - preview/2023-01-01-preview/communicationservicessiprouting.json
+title:
+ Azure Communication Services
```
### Tag: package-2022-10-01-preview
@@ -63,17 +74,6 @@ title:
Azure Communication Services
```
-### Tag: package-2022-10-01-preview
-
-These settings apply only when `--tag=package-2022-05-01-preview` is specified on the command line.
-
-```yaml $(tag) == 'package-2022-10-01-preview'
-input-file:
- - preview/2022-10-01-preview/communicationservicessiprouting.json
-title:
- Azure Communication Services
-```
-
---
# Code Generation
diff --git a/specification/communication/data-plane/SipRouting/readme.python.md b/specification/communication/data-plane/SipRouting/readme.python.md
index e269f7de29d9..553af2866639 100644
--- a/specification/communication/data-plane/SipRouting/readme.python.md
+++ b/specification/communication/data-plane/SipRouting/readme.python.md
@@ -10,7 +10,7 @@ python:
payload-flattening-threshold: 2
namespace: Microsoft.CommunicationServices
package-name: communicationservices
- package-version: 2022-10-01-preview
+ package-version: 2023-01-01-preview
clear-output-folder: true
```
diff --git a/specification/communication/data-plane/SipRouting/readme.ruby.md b/specification/communication/data-plane/SipRouting/readme.ruby.md
index 0d779b051c5e..a80b06a4f479 100644
--- a/specification/communication/data-plane/SipRouting/readme.ruby.md
+++ b/specification/communication/data-plane/SipRouting/readme.ruby.md
@@ -2,6 +2,19 @@
These settings apply only when `--ruby` is specified on the command line.
+### Tag: package-2023-01-01-preview and ruby
+
+These settings apply only when `--tag=package-2023-01-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+```yaml $(tag) == 'package-2023-01-01-preview' && $(ruby)
+package-name: azure_mgmt_communicationservices
+package-version: 2023-01-01-preview
+azure-arm: true
+namespace: Microsoft.CommunicationServices
+output-folder: $(ruby-sdks-folder)/communicationservices
+```
+
### Tag: package-2022-10-01-preview and ruby
These settings apply only when `--tag=package-2022-10-01-preview --ruby` is specified on the command line.
@@ -9,7 +22,7 @@ Please also specify `--ruby-sdks-folder=
NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.",
+ "type": "string",
+ "readOnly": true
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceInstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ }
+ }
+ },
+ "RoleInstanceProperties": {
+ "description": "Role instance properties.",
+ "type": "object",
+ "properties": {
+ "networkProfile": {
+ "$ref": "#/definitions/RoleInstanceNetworkProfile"
+ },
+ "instanceView": {
+ "$ref": "#/definitions/RoleInstanceInstanceView"
+ }
+ }
+ },
+ "RoleInstance": {
+ "description": "Describes the cloud service role instance.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource Name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource Type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Resource Location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "sku": {
+ "$ref": "#/definitions/InstanceSku"
+ },
+ "properties": {
+ "$ref": "#/definitions/RoleInstanceProperties"
+ }
+ }
+ },
+ "RoleInstanceListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RoleInstance"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "CloudServiceRoleSku": {
+ "description": "Describes the cloud service role sku.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.",
+ "type": "string"
+ },
+ "tier": {
+ "description": "Specifies the tier of the cloud service. Possible Values are
**Standard**
**Basic**",
+ "type": "string"
+ },
+ "capacity": {
+ "format": "int64",
+ "description": "Specifies the number of role instances in the cloud service.",
+ "type": "integer"
+ }
+ }
+ },
+ "CloudServiceRoleProperties": {
+ "description": "The cloud service role properties.",
+ "type": "object",
+ "properties": {
+ "uniqueId": {
+ "description": "Specifies the ID which uniquely identifies a cloud service role.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CloudServiceRole": {
+ "description": "Describes a role of the cloud service.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource id",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Resource location",
+ "type": "string",
+ "readOnly": true
+ },
+ "sku": {
+ "$ref": "#/definitions/CloudServiceRoleSku"
+ },
+ "properties": {
+ "$ref": "#/definitions/CloudServiceRoleProperties"
+ }
+ }
+ },
+ "CloudServiceRoleListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudServiceRole"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "CloudServiceUpgradeMode": {
+ "description": "Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.\r\nPossible Values are
**Auto**
**Manual**
**Simultaneous**
\r\nIf not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.",
+ "enum": [
+ "Auto",
+ "Manual",
+ "Simultaneous"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CloudServiceUpgradeMode",
+ "modelAsString": true
+ }
+ },
+ "CloudServiceRoleProfileProperties": {
+ "description": "Describes the role properties.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Resource name.",
+ "type": "string"
+ },
+ "sku": {
+ "$ref": "#/definitions/CloudServiceRoleSku"
+ }
+ }
+ },
+ "CloudServiceRoleProfile": {
+ "description": "Describes the role profile for the cloud service.",
+ "type": "object",
+ "properties": {
+ "roles": {
+ "description": "List of roles for the cloud service.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudServiceRoleProfileProperties"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "CloudServiceVaultCertificate": {
+ "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance.",
+ "type": "object",
+ "properties": {
+ "certificateUrl": {
+ "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret.",
+ "type": "string"
+ }
+ }
+ },
+ "CloudServiceVaultSecretGroup": {
+ "description": "Describes a set of certificates which are all in the same Key Vault.",
+ "type": "object",
+ "properties": {
+ "sourceVault": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates."
+ },
+ "vaultCertificates": {
+ "description": "The list of key vault references in SourceVault which contain certificates.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudServiceVaultCertificate"
+ },
+ "x-ms-identifiers": [
+ "certificateUrl"
+ ]
+ }
+ }
+ },
+ "CloudServiceOsProfile": {
+ "description": "Describes the OS profile for the cloud service.",
+ "type": "object",
+ "properties": {
+ "secrets": {
+ "description": "Specifies set of certificates that should be installed onto the role instances.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudServiceVaultSecretGroup"
+ },
+ "x-ms-identifiers": [
+ "sourceVault/id"
+ ]
+ }
+ }
+ },
+ "LoadBalancerFrontendIpConfigurationProperties": {
+ "description": "Describes a cloud service IP Configuration",
+ "type": "object",
+ "properties": {
+ "publicIPAddress": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The reference to the public ip address resource."
+ },
+ "subnet": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The reference to the virtual network subnet resource."
+ },
+ "privateIPAddress": {
+ "description": "The virtual network private IP address of the IP configuration.",
+ "type": "string"
+ }
+ }
+ },
+ "LoadBalancerFrontendIpConfiguration": {
+ "description": "Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/LoadBalancerFrontendIpConfigurationProperties",
+ "description": "Properties of load balancer frontend ip configuration."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "LoadBalancerConfigurationProperties": {
+ "description": "Describes the properties of the load balancer configuration.",
+ "type": "object",
+ "properties": {
+ "frontendIpConfigurations": {
+ "description": "Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LoadBalancerFrontendIpConfiguration"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ },
+ "required": [
+ "frontendIpConfigurations"
+ ]
+ },
+ "LoadBalancerConfiguration": {
+ "description": "Describes the load balancer configuration.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the Load balancer",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/LoadBalancerConfigurationProperties",
+ "description": "Properties of the load balancer configuration."
+ }
+ },
+ "required": [
+ "name",
+ "properties"
+ ]
+ },
+ "CloudServiceSlotType": {
+ "description": "Slot type for the cloud service.\r\nPossible values are
**Production**
**Staging**
\r\nIf not specified, the default value is Production.",
+ "enum": [
+ "Production",
+ "Staging"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CloudServiceSlotType",
+ "modelAsString": true
+ }
+ },
+ "CloudServiceNetworkProfile": {
+ "description": "Network Profile for the cloud service.",
+ "type": "object",
+ "properties": {
+ "loadBalancerConfigurations": {
+ "description": "List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LoadBalancerConfiguration"
+ }
+ },
+ "slotType": {
+ "$ref": "#/definitions/CloudServiceSlotType"
+ },
+ "swappableCloudService": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown."
+ }
+ }
+ },
+ "CloudServiceVaultAndSecretReference": {
+ "type": "object",
+ "properties": {
+ "sourceVault": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The ARM Resource ID of the Key Vault"
+ },
+ "secretUrl": {
+ "type": "string",
+ "description": "Secret URL which contains the protected settings of the extension"
+ }
+ },
+ "description": "Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance."
+ },
+ "CloudServiceExtensionProperties": {
+ "description": "Extension Properties.",
+ "type": "object",
+ "properties": {
+ "publisher": {
+ "description": "The name of the extension handler publisher.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Specifies the type of the extension.",
+ "type": "string"
+ },
+ "typeHandlerVersion": {
+ "description": "Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.",
+ "type": "string"
+ },
+ "autoUpgradeMinorVersion": {
+ "description": "Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.",
+ "type": "boolean"
+ },
+ "settings": {
+ "description": "Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.",
+ "type": "object"
+ },
+ "protectedSettings": {
+ "description": "Protected settings for the extension which are encrypted before sent to the role instance.",
+ "type": "object"
+ },
+ "protectedSettingsFromKeyVault": {
+ "$ref": "#/definitions/CloudServiceVaultAndSecretReference"
+ },
+ "forceUpdateTag": {
+ "description": "Tag to force apply the provided public and protected settings.\r\nChanging the tag value allows for re-running the extension without changing any of the public or protected settings.\r\nIf forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.\r\nIf neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and\r\nit is up to handler implementation whether to re-run it or not",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "The provisioning state, which only appears in the response.",
+ "type": "string",
+ "readOnly": true
+ },
+ "rolesAppliedTo": {
+ "description": "Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "Extension": {
+ "description": "Describes a cloud service Extension.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the extension.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/CloudServiceExtensionProperties"
+ }
+ }
+ },
+ "CloudServiceExtensionProfile": {
+ "description": "Describes a cloud service extension profile.",
+ "type": "object",
+ "properties": {
+ "extensions": {
+ "description": "List of extensions for the cloud service.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Extension"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "CloudServiceProperties": {
+ "description": "Cloud service properties",
+ "type": "object",
+ "properties": {
+ "packageUrl": {
+ "description": "Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\nThis is a write-only property and is not returned in GET calls.",
+ "type": "string"
+ },
+ "configuration": {
+ "description": "Specifies the XML service configuration (.cscfg) for the cloud service.",
+ "type": "string"
+ },
+ "configurationUrl": {
+ "description": "Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\nThis is a write-only property and is not returned in GET calls.",
+ "type": "string"
+ },
+ "startCloudService": {
+ "description": "(Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.\r\nIf false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.",
+ "type": "boolean"
+ },
+ "allowModelOverride": {
+ "description": "(Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.\r\nThe default value is `false`.",
+ "type": "boolean"
+ },
+ "upgradeMode": {
+ "$ref": "#/definitions/CloudServiceUpgradeMode"
+ },
+ "roleProfile": {
+ "$ref": "#/definitions/CloudServiceRoleProfile"
+ },
+ "osProfile": {
+ "$ref": "#/definitions/CloudServiceOsProfile"
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/CloudServiceNetworkProfile"
+ },
+ "extensionProfile": {
+ "$ref": "#/definitions/CloudServiceExtensionProfile"
+ },
+ "provisioningState": {
+ "description": "The provisioning state, which only appears in the response.",
+ "type": "string",
+ "readOnly": true
+ },
+ "uniqueId": {
+ "description": "The unique identifier for the cloud service.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CloudService": {
+ "description": "Describes the cloud service.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/CloudServiceProperties"
+ },
+ "systemData": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SystemData"
+ },
+ "zones": {
+ "description": "List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-azure-resource": true,
+ "required": [
+ "location"
+ ]
+ },
+ "CloudServiceUpdate": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "StatusCodeCount": {
+ "description": "The status code and count of the cloud service instance view statuses",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The instance view status code",
+ "type": "string",
+ "readOnly": true
+ },
+ "count": {
+ "format": "int32",
+ "description": "Number of instances having this status code",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "InstanceViewStatusesSummary": {
+ "description": "Instance view statuses.",
+ "type": "object",
+ "properties": {
+ "statusesSummary": {
+ "description": "The summary.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StatusCodeCount"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ }
+ }
+ },
+ "CloudServiceInstanceView": {
+ "description": "InstanceView of CloudService as a whole",
+ "type": "object",
+ "properties": {
+ "roleInstance": {
+ "$ref": "#/definitions/InstanceViewStatusesSummary"
+ },
+ "sdkVersion": {
+ "description": "The version of the SDK that was used to generate the package for the cloud service.",
+ "type": "string",
+ "readOnly": true
+ },
+ "privateIds": {
+ "description": "Specifies a list of unique identifiers generated internally for the cloud service.
NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceInstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ }
+ }
+ },
+ "CloudServiceListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudService"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "RoleInstances": {
+ "description": "Specifies a list of role instances from the cloud service.",
+ "type": "object",
+ "properties": {
+ "roleInstances": {
+ "description": "List of cloud service role instance names. Value of '*' will signify all role instances of the cloud service.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "roleInstances"
+ ]
+ },
+ "UpdateDomain": {
+ "description": "Defines an update domain for the cloud service.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource Name",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateDomainListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdateDomain"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "OSVersionProperties": {
+ "description": "OS version properties.",
+ "type": "object",
+ "properties": {
+ "family": {
+ "description": "The family of this OS version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "familyLabel": {
+ "description": "The family label of this OS version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "The OS version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "label": {
+ "description": "The OS version label.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDefault": {
+ "description": "Specifies whether this is the default OS version for its family.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isActive": {
+ "description": "Specifies whether this OS version is active.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "OSVersion": {
+ "description": "Describes a cloud service OS version.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/OSVersionProperties"
+ }
+ }
+ },
+ "OSVersionListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OSVersion"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "OSVersionPropertiesBase": {
+ "description": "Configuration view of an OS version.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "The OS version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "label": {
+ "description": "The OS version label.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDefault": {
+ "description": "Specifies whether this is the default OS version for its family.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isActive": {
+ "description": "Specifies whether this OS version is active.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "OSFamilyProperties": {
+ "description": "OS family properties.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The OS family name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "label": {
+ "description": "The OS family label.",
+ "type": "string",
+ "readOnly": true
+ },
+ "versions": {
+ "description": "List of OS versions belonging to this family.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OSVersionPropertiesBase"
+ },
+ "x-ms-identifiers": [
+ "version"
+ ],
+ "readOnly": true
+ }
+ }
+ },
+ "OSFamily": {
+ "description": "Describes a cloud service OS family.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/OSFamilyProperties"
+ }
+ }
+ },
+ "OSFamilyListResult": {
+ "description": "The list operation result.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OSFamily"
+ }
+ },
+ "nextLink": {
+ "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamilies_List.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamilies_List.json
new file mode 100644
index 000000000000..fe45efc47eb9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamilies_List.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus2",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "3",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSFamilies/3",
+ "type": "Microsoft.Compute/locations/cloudServiceOsFamilies",
+ "location": "westus2",
+ "properties": {
+ "name": "3",
+ "label": "Windows Server 2012",
+ "versions": [
+ {
+ "version": "WA-GUEST-OS-3.90_202010-02",
+ "label": "Windows Azure Guest OS 3.90 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true
+ }
+ ]
+ }
+ },
+ {
+ "name": "4",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSFamilies/4",
+ "type": "Microsoft.Compute/locations/cloudServiceOsFamilies",
+ "location": "westus2",
+ "properties": {
+ "name": "4",
+ "label": "Windows Server 2012 R2",
+ "versions": [
+ {
+ "version": "WA-GUEST-OS-4.83_202010-02",
+ "label": "Windows Azure Guest OS 4.83 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamily_Get.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamily_Get.json
new file mode 100644
index 000000000000..9bc568ec9bc6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSFamily_Get.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus2",
+ "osFamilyName": "3",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "3",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSFamilies/3",
+ "type": "Microsoft.Compute/locations/cloudServiceOsFamilies",
+ "location": "westus2",
+ "properties": {
+ "name": "3",
+ "label": "Windows Server 2012",
+ "versions": [
+ {
+ "version": "WA-GUEST-OS-3.90_202010-02",
+ "label": "Windows Azure Guest OS 3.90 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_Get.json
new file mode 100644
index 000000000000..31f17f3854c2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_Get.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus2",
+ "osVersionName": "WA-GUEST-OS-3.90_202010-02",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "WA-GUEST-OS-3.90_202010-02",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSVersions/WA-GUEST-OS-3.90_202010-02",
+ "type": "Microsoft.Compute/locations/cloudServiceOsVersions",
+ "location": "westus2",
+ "properties": {
+ "version": "WA-GUEST-OS-3.90_202010-02",
+ "label": "Windows Azure Guest OS 3.90 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true,
+ "family": "3",
+ "familyLabel": "Windows Server 2012"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_List.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_List.json
new file mode 100644
index 000000000000..ecf56693b19f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceOSVersion_List.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus2",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "WA-GUEST-OS-3.90_202010-02",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSVersions/WA-GUEST-OS-3.90_202010-02",
+ "type": "Microsoft.Compute/locations/cloudServiceOsVersions",
+ "location": "westus2",
+ "properties": {
+ "version": "WA-GUEST-OS-3.90_202010-02",
+ "label": "Windows Azure Guest OS 3.90 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true,
+ "family": "3",
+ "familyLabel": "Windows Server 2012"
+ }
+ },
+ {
+ "name": "WA-GUEST-OS-4.83_202010-02",
+ "id": "/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/westus2/cloudServiceOSVersions/WA-GUEST-OS-4.83_202010-02",
+ "type": "Microsoft.Compute/locations/cloudServiceOsVersions",
+ "location": "westus2",
+ "properties": {
+ "version": "WA-GUEST-OS-4.83_202010-02",
+ "label": "Windows Azure Guest OS 4.83 (Release 202010-02)",
+ "isDefault": true,
+ "isActive": true,
+ "family": "4",
+ "familyLabel": "Windows Server 2012 R2"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete.json
new file mode 100644
index 000000000000..7e04cde00272
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete_ByCloudService.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete_ByCloudService.json
new file mode 100644
index 000000000000..235d2786106b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Delete_ByCloudService.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "roleInstances": [
+ "ContosoFrontend_IN_0",
+ "ContosoBackend_IN_1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get.json
new file mode 100644
index 000000000000..a5c40c6e70bd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{roleInstance-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/{roleInstance-name}",
+ "type": "Microsoft.Compute/cloudServices/roleInstances",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard"
+ },
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/{roleInstance-name}/networkInterfaces/nic1"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_InstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_InstanceView.json
new file mode 100644
index 000000000000..76436bda46f4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_InstanceView.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "platformUpdateDomain": 0,
+ "platformFaultDomain": 0,
+ "privateId": "3491bc0c-1f6c-444f-b1d0-ec0751a74e3e",
+ "statuses": [
+ {
+ "code": "RoleState/RoleStateStarted",
+ "level": "Info",
+ "displayStatus": "RoleStateStarted",
+ "message": ""
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json
new file mode 100644
index 000000000000..5069e254f6eb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "roleInstanceName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "resourceGroupName": "rgcloudService",
+ "cloudServiceName": "aaaa",
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild.json
new file mode 100644
index 000000000000..e2df70baeebc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild_ByCloudService.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild_ByCloudService.json
new file mode 100644
index 000000000000..235d2786106b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Rebuild_ByCloudService.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "roleInstances": [
+ "ContosoFrontend_IN_0",
+ "ContosoBackend_IN_1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage.json
new file mode 100644
index 000000000000..e2df70baeebc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage_ByCloudService.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage_ByCloudService.json
new file mode 100644
index 000000000000..235d2786106b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Reimage_ByCloudService.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "roleInstances": [
+ "ContosoFrontend_IN_0",
+ "ContosoBackend_IN_1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart.json
new file mode 100644
index 000000000000..e2df70baeebc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleInstanceName": "{roleInstance-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart_ByCloudService.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart_ByCloudService.json
new file mode 100644
index 000000000000..235d2786106b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRoleInstance_Restart_ByCloudService.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "roleInstances": [
+ "ContosoFrontend_IN_0",
+ "ContosoBackend_IN_1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_Get.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_Get.json
new file mode 100644
index 000000000000..b5da6e749612
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_Get.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "roleName": "{role-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{role-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roles/{role-name}",
+ "type": "Microsoft.Compute/cloudServices/roles",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ },
+ "properties": {
+ "uniqueId": "b03bc269-766b-4921-b91a-7dffaae4d03b:{role-name}"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_List.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_List.json
new file mode 100644
index 000000000000..c1f27f2b3844
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRole_List.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "ContosoFrontend",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roles/ContosoFrontend",
+ "type": "Microsoft.Compute/cloudServices/roles",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ },
+ "properties": {
+ "uniqueId": "b03bc269-766b-4921-b91a-7dffaae4d03b:ContosoFrontend"
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roles/ContosoBackend",
+ "type": "Microsoft.Compute/cloudServices/roles",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ },
+ "properties": {
+ "uniqueId": "b03bc269-766b-4921-b91a-7dffaae4d03b:ContosoBackend"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRolesInstance_List.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRolesInstance_List.json
new file mode 100644
index 000000000000..724c61ffb369
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceRolesInstance_List.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "ContosoFrontend_IN_0",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoFrontend_IN_0",
+ "type": "Microsoft.Compute/cloudServices/roleInstances",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard"
+ },
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoFrontend_IN_0/networkInterfaces/nic1"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "ContosoFrontend_IN_1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoFrontend_IN_1",
+ "type": "Microsoft.Compute/cloudServices/roleInstances",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard"
+ },
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoFrontend_IN_1/networkInterfaces/nic1"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "ContosoBackend_IN_0",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoBackend_IN_0",
+ "type": "Microsoft.Compute/cloudServices/roleInstances",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard"
+ },
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoBackend_IN_0/networkInterfaces/nic1"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "ContosoBackend_IN_1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoBackend_IN_1",
+ "type": "Microsoft.Compute/cloudServices/roleInstances",
+ "location": "eastus2euap",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard"
+ },
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roleInstances/ContosoBackend_IN_1/networkInterfaces/nic1"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Get.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Get.json
new file mode 100644
index 000000000000..c544953611a6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Get.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "updateDomain": 1,
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/updateDomains/1"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_List.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_List.json
new file mode 100644
index 000000000000..fd2b95aa230f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_List.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "0",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/updateDomains/0"
+ },
+ {
+ "name": "1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/updateDomains/1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Update.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Update.json
new file mode 100644
index 000000000000..018b1b071586
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudServiceUpdateDomain_Update.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "updateDomain": 1,
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole.json
new file mode 100644
index 000000000000..442be911e01a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole.json
@@ -0,0 +1,182 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "properties": {
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ },
+ "name": "contosofe"
+ }
+ ]
+ },
+ "name": "contosolb"
+ }
+ ]
+ },
+ "roleProfile": {
+ "roles": [
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoFrontend"
+ },
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoBackend"
+ }
+ ]
+ },
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "7f3edf91-cb34-4a3e-971a-177dc3dd43cb"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Creating",
+ "uniqueId": "7f3edf91-cb34-4a3e-971a-177dc3dd43cb"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole_WithZones.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole_WithZones.json
new file mode 100644
index 000000000000..90212973cce1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithMultiRole_WithZones.json
@@ -0,0 +1,191 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "properties": {
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ },
+ "name": "contosofe"
+ }
+ ]
+ },
+ "name": "contosolb"
+ }
+ ]
+ },
+ "roleProfile": {
+ "roles": [
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoFrontend"
+ },
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoBackend"
+ }
+ ]
+ },
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto"
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "7f3edf91-cb34-4a3e-971a-177dc3dd43cb"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ },
+ "zones": [
+ "1"
+ ]
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Creating",
+ "uniqueId": "7f3edf91-cb34-4a3e-971a-177dc3dd43cb"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ },
+ "zones": [
+ "1"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRole.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRole.json
new file mode 100644
index 000000000000..5ea19d998e36
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRole.json
@@ -0,0 +1,158 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/myPublicIP"
+ }
+ },
+ "name": "myfe"
+ }
+ ]
+ },
+ "name": "myLoadBalancer"
+ }
+ ]
+ },
+ "roleProfile": {
+ "roles": [
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoFrontend"
+ }
+ ]
+ },
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/5393f919-a68a-43d0-9063-4b2bda6bffdf/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "packageUrl": "{PackageUrl}",
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/myPublicIP"
+ }
+ },
+ "name": "myfe"
+ }
+ ]
+ },
+ "name": "myLoadBalancer"
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "14d10b45-ced7-42ef-a406-50a3df2cea7d"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/5393f919-a68a-43d0-9063-4b2bda6bffdf/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "packageUrl": "{PackageUrl}",
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/myPublicIP"
+ }
+ },
+ "name": "myfe"
+ }
+ ]
+ },
+ "name": "myLoadBalancer"
+ }
+ ]
+ },
+ "provisioningState": "Creating",
+ "uniqueId": "14d10b45-ced7-42ef-a406-50a3df2cea7d"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndCertificate.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndCertificate.json
new file mode 100644
index 000000000000..a076b99a38a0
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndCertificate.json
@@ -0,0 +1,194 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ },
+ "name": "contosofe"
+ }
+ ]
+ },
+ "name": "contosolb"
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.KeyVault/vaults/{keyvault-name}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "https://{keyvault-name}.vault.azure.net:443/secrets/ContosoCertificate/{secret-id}"
+ }
+ ]
+ }
+ ]
+ },
+ "roleProfile": {
+ "roles": [
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoFrontend"
+ }
+ ]
+ },
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.KeyVault/vaults/{keyvault-name}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "https://{keyvault-name}.vault.azure.net:443/secrets/ContosoCertificate/{secret-id}"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "60b6cd59-600b-4e02-b717-521b07aa94bf"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.KeyVault/vaults/{keyvault-name}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "https://{keyvault-name}.vault.azure.net:443/secrets/ContosoCertificate/{secret-id}"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Creating",
+ "uniqueId": "60b6cd59-600b-4e02-b717-521b07aa94bf"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndRDP.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndRDP.json
new file mode 100644
index 000000000000..ca4e985fdcf4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Create_WithSingleRoleAndRDP.json
@@ -0,0 +1,209 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "properties": {
+ "extensionProfile": {
+ "extensions": [
+ {
+ "properties": {
+ "type": "RDP",
+ "autoUpgradeMinorVersion": false,
+ "protectedSettings": "{password}",
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "settings": "UserAzure10/22/2021 15:05:45",
+ "typeHandlerVersion": "1.2"
+ },
+ "name": "RDPExtension"
+ }
+ ]
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ },
+ "name": "contosofe"
+ }
+ ]
+ },
+ "name": "contosolb"
+ }
+ ]
+ },
+ "roleProfile": {
+ "roles": [
+ {
+ "sku": {
+ "name": "Standard_D1_v2",
+ "capacity": 1,
+ "tier": "Standard"
+ },
+ "name": "ContosoFrontend"
+ }
+ ]
+ },
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "RDPExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "provisioningState": "Creating",
+ "rolesAppliedTo": [
+ "*"
+ ],
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "type": "RDP",
+ "typeHandlerVersion": "1.2",
+ "settings": "UserAzure10/22/2021 15:05:45"
+ }
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "c948cccb-bbfa-4516-a250-c28abc4d0c15"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "westus",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "packageUrl": "{PackageUrl}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 1
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "RDPExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "provisioningState": "Creating",
+ "rolesAppliedTo": [
+ "*"
+ ],
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "type": "RDP",
+ "typeHandlerVersion": "1.2",
+ "settings": "UserAzure10/22/2021 15:05:45"
+ }
+ }
+ ]
+ },
+ "provisioningState": "Creating",
+ "uniqueId": "c948cccb-bbfa-4516-a250-c28abc4d0c15"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Delete.json
new file mode 100644
index 000000000000..376fc5a09a57
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Delete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_InstanceViewWithMultiRole.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_InstanceViewWithMultiRole.json
new file mode 100644
index 000000000000..94a9c3976365
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_InstanceViewWithMultiRole.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "roleInstance": {
+ "statusesSummary": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "count": 4
+ },
+ {
+ "code": "PowerState/started",
+ "count": 4
+ },
+ {
+ "code": "RoleState/RoleStateStarted",
+ "count": 4
+ }
+ ]
+ },
+ "sdkVersion": "2.9.6496.3",
+ "privateIds": [
+ "3491bc0c-1f6c-444f-b1d0-ec0751a74e3e"
+ ],
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2021-01-12T16:50:07.0953535+05:30"
+ },
+ {
+ "code": "PowerState/started",
+ "level": "Info",
+ "displayStatus": "Started",
+ "time": "2021-01-12T16:50:07.0953535+05:30"
+ },
+ {
+ "code": "CurrentUpgradeDomain/-1",
+ "level": "Info",
+ "displayStatus": "Current Upgrade Domain of cloud service is -1."
+ },
+ {
+ "code": "MaxUpgradeDomain/1",
+ "level": "Info",
+ "displayStatus": "Max Upgrade Domain of cloud service is 1."
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_WithMultiRoleAndRDP.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
new file mode 100644
index 000000000000..d411cecbc48a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Get_WithMultiRoleAndRDP.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "eastus2euap",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "RDPExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "provisioningState": "Succeeded",
+ "rolesAppliedTo": [
+ "*"
+ ],
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "type": "RDP",
+ "typeHandlerVersion": "1.2",
+ "settings": "userazure01/12/2022 16:29:02"
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
+ },
+ "systemData": {
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_ByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_ByResourceGroup.json
new file mode 100644
index 000000000000..8c3b517f19b5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_ByResourceGroup.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "eastus2euap",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "RDPExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "provisioningState": "Succeeded",
+ "rolesAppliedTo": [
+ "*"
+ ],
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "type": "RDP",
+ "typeHandlerVersion": "1.2",
+ "settings": "userazure01/12/2022 16:29:02"
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_BySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_BySubscription.json
new file mode 100644
index 000000000000..942c61c6dbc8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_List_BySubscription.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "eastus2euap",
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "RDPExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "provisioningState": "Succeeded",
+ "rolesAppliedTo": [
+ "*"
+ ],
+ "publisher": "Microsoft.Windows.Azure.Extensions",
+ "type": "RDP",
+ "typeHandlerVersion": "1.2",
+ "settings": "userazure01/12/2022 16:29:02"
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_PowerOff.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_PowerOff.json
new file mode 100644
index 000000000000..76d7094f2d61
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_PowerOff.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Start.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Start.json
new file mode 100644
index 000000000000..76d7094f2d61
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Start.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Update_ToIncludeTags.json b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Update_ToIncludeTags.json
new file mode 100644
index 000000000000..e974d43a4cd4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/CloudserviceRP/stable/2022-09-04/examples/CloudService_Update_ToIncludeTags.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ConstosoRG",
+ "cloudServiceName": "{cs-name}",
+ "api-version": "2022-09-04",
+ "parameters": {
+ "tags": {
+ "Documentation": "RestAPI"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{cs-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
+ "type": "Microsoft.Compute/cloudServices",
+ "location": "eastus2euap",
+ "tags": {
+ "Documentation": "RestAPI"
+ },
+ "properties": {
+ "configuration": "{ServiceConfiguration}",
+ "upgradeMode": "Auto",
+ "roleProfile": {
+ "roles": [
+ {
+ "name": "ContosoFrontend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ },
+ {
+ "name": "ContosoBackend",
+ "sku": {
+ "name": "Standard_D1_v2",
+ "tier": "Standard",
+ "capacity": 2
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "secrets": []
+ },
+ "networkProfile": {
+ "loadBalancerConfigurations": [
+ {
+ "name": "contosolb",
+ "properties": {
+ "frontendIpConfigurations": [
+ {
+ "name": "contosofe",
+ "properties": {
+ "publicIPAddress": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "provisioningState": "Updating",
+ "uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/availabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/availabilitySet.json
new file mode 100644
index 000000000000..bb80f08a62b2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/availabilitySet.json
@@ -0,0 +1,514 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": {
+ "put": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_CreateOrUpdate",
+ "description": "Create or update an availability set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "availabilitySetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the availability set."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySet"
+ },
+ "description": "Parameters supplied to the Create Availability Set operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create an availability set.": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Create.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_Update",
+ "description": "Update an availability set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "availabilitySetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the availability set."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySetUpdate"
+ },
+ "description": "Parameters supplied to the Update Availability Set operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AvailabilitySets_Update_MaximumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Update_MaximumSet_Gen.json"
+ },
+ "AvailabilitySets_Update_MinimumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_Delete",
+ "description": "Delete an availability set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "availabilitySetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the availability set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AvailabilitySets_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Delete_MaximumSet_Gen.json"
+ },
+ "AvailabilitySets_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_Get",
+ "description": "Retrieves information about an availability set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "availabilitySetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the availability set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AvailabilitySets_Get_MaximumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Get_MaximumSet_Gen.json"
+ },
+ "AvailabilitySets_Get_MinimumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": {
+ "get": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_ListBySubscription",
+ "description": "Lists all availability sets in a subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySetListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List availability sets in a subscription.": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": {
+ "get": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_List",
+ "description": "Lists all availability sets in a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AvailabilitySetListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AvailabilitySets_List_MaximumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_List_MaximumSet_Gen.json"
+ },
+ "AvailabilitySets_List_MinimumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": {
+ "get": {
+ "tags": [
+ "AvailabilitySets"
+ ],
+ "operationId": "AvailabilitySets_ListAvailableSizes",
+ "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "availabilitySetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the availability set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "AvailabilitySets_ListAvailableSizes_MaximumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MaximumSet_Gen.json"
+ },
+ "AvailabilitySets_ListAvailableSizes_MinimumSet_Gen": {
+ "$ref": "./examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MinimumSet_Gen.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AvailabilitySetProperties": {
+ "properties": {
+ "platformUpdateDomainCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Update Domain count."
+ },
+ "platformFaultDomainCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Fault Domain count."
+ },
+ "virtualMachines": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "A list of references to all virtual machines in the availability set."
+ },
+ "proximityPlacementGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the proximity placement group that the availability set should be assigned to.
Minimum api-version: 2018-04-01."
+ },
+ "statuses": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a resource."
+ },
+ "AvailabilitySetSkuType": {
+ "type": "string",
+ "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.",
+ "enum": [
+ "Classic",
+ "Aligned"
+ ],
+ "x-ms-enum": {
+ "name": "AvailabilitySetSkuTypes",
+ "modelAsString": true
+ }
+ },
+ "AvailabilitySet": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AvailabilitySetProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates)
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set."
+ },
+ "AvailabilitySetUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/AvailabilitySetProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "Sku of the availability set"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated."
+ },
+ "AvailabilitySetListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AvailabilitySet"
+ },
+ "description": "The list of availability sets"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Availability Set operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/capacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/capacityReservation.json
new file mode 100644
index 000000000000..490a5fb38281
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/capacityReservation.json
@@ -0,0 +1,990 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}": {
+ "put": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_CreateOrUpdate",
+ "description": "The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags may be modified. Please refer to https://aka.ms/CapacityReservation for more details.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ },
+ "description": "Parameters supplied to the Create capacity reservation Group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a capacity reservation group.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_Update",
+ "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags may be modified.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroupUpdate"
+ },
+ "description": "Parameters supplied to the Update capacity reservation Group operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CapacityReservationGroups_Update_MaximumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json"
+ },
+ "CapacityReservationGroups_Update_MinimumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_Delete",
+ "description": "The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CapacityReservationGroups_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json"
+ },
+ "CapacityReservationGroups_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_Get",
+ "description": "The operation that retrieves information about a capacity reservation group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.",
+ "enum": [
+ "instanceView"
+ ],
+ "x-ms-enum": {
+ "name": "CapacityReservationGroupInstanceViewTypes",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a capacity reservation Group.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups": {
+ "get": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_ListByResourceGroup",
+ "description": "Lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.",
+ "enum": [
+ "virtualMachineScaleSetVMs/$ref",
+ "virtualMachines/$ref"
+ ],
+ "x-ms-enum": {
+ "name": "ExpandTypesForGetCapacityReservationGroups",
+ "modelAsString": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List capacity reservation groups in resource group.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups": {
+ "get": {
+ "tags": [
+ "CapacityReservationGroups"
+ ],
+ "operationId": "CapacityReservationGroups_ListBySubscription",
+ "description": "Lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.",
+ "enum": [
+ "virtualMachineScaleSetVMs/$ref",
+ "virtualMachines/$ref"
+ ],
+ "x-ms-enum": {
+ "name": "ExpandTypesForGetCapacityReservationGroups",
+ "modelAsString": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List capacity reservation groups in subscription.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}": {
+ "put": {
+ "tags": [
+ "CapacityReservations"
+ ],
+ "operationId": "CapacityReservations_CreateOrUpdate",
+ "description": "The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to https://aka.ms/CapacityReservation for more details.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "capacityReservationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CapacityReservation"
+ },
+ "description": "Parameters supplied to the Create capacity reservation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservation"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a capacity reservation .": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "CapacityReservations"
+ ],
+ "operationId": "CapacityReservations_Update",
+ "description": "The operation to update a capacity reservation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "capacityReservationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationUpdate"
+ },
+ "description": "Parameters supplied to the Update capacity reservation operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservation"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "CapacityReservations_Update_MaximumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json"
+ },
+ "CapacityReservations_Update_MinimumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "CapacityReservations"
+ ],
+ "operationId": "CapacityReservations_Delete",
+ "description": "The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. Please refer to https://aka.ms/CapacityReservation for more details.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "capacityReservationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "CapacityReservations_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json"
+ },
+ "CapacityReservations_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "CapacityReservations"
+ ],
+ "operationId": "CapacityReservations_Get",
+ "description": "The operation that retrieves information about the capacity reservation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "name": "capacityReservationName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.",
+ "enum": [
+ "instanceView"
+ ],
+ "x-ms-enum": {
+ "name": "CapacityReservationInstanceViewTypes",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a capacity reservation.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations": {
+ "get": {
+ "tags": [
+ "CapacityReservation"
+ ],
+ "operationId": "CapacityReservations_ListByCapacityReservationGroup",
+ "description": "Lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "capacityReservationGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the capacity reservation group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CapacityReservationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List capacity reservations in reservation group.": {
+ "$ref": "./examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "CapacityReservationGroupInstanceView": {
+ "type": "object",
+ "properties": {
+ "capacityReservations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CapacityReservationInstanceViewWithName"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "readOnly": true,
+ "description": "List of instance view of the capacity reservations under the capacity reservation group."
+ }
+ }
+ },
+ "CapacityReservationGroupProperties": {
+ "type": "object",
+ "properties": {
+ "capacityReservations": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of all capacity reservation resource ids that belong to capacity reservation group."
+ },
+ "virtualMachinesAssociated": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of references to all virtual machines associated to the capacity reservation group."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/CapacityReservationGroupInstanceView",
+ "readOnly": true,
+ "description": "The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group."
+ }
+ },
+ "description": "capacity reservation group Properties."
+ },
+ "CapacityReservationGroup": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CapacityReservationGroupProperties"
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Specifies information about the capacity reservation group that the capacity reservations should be assigned to.
Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group."
+ },
+ "CapacityReservationGroupUpdate": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CapacityReservationGroupProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the capacity reservation group. Only tags can be updated."
+ },
+ "CapacityReservationGroupListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CapacityReservationGroup"
+ },
+ "description": "The list of capacity reservation groups"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List capacity reservation group with resource group response."
+ },
+ "CapacityReservationInstanceView": {
+ "type": "object",
+ "properties": {
+ "utilizationInfo": {
+ "$ref": "#/definitions/CapacityReservationUtilization",
+ "description": "Unutilized capacity of the capacity reservation."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations."
+ },
+ "CapacityReservationUtilization": {
+ "type": "object",
+ "properties": {
+ "currentCapacity": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed.
Minimum api-version: 2022-08-01."
+ },
+ "virtualMachinesAllocated": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of all virtual machines resource ids allocated against the capacity reservation."
+ }
+ },
+ "description": "Represents the capacity reservation utilization in terms of resources allocated."
+ },
+ "CapacityReservationInstanceViewWithName": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the capacity reservation."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/CapacityReservationInstanceView"
+ }
+ ],
+ "description": "The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group."
+ },
+ "CapacityReservationProperties": {
+ "type": "object",
+ "properties": {
+ "reservationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource."
+ },
+ "platformFaultDomainCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the value of fault domain count that Capacity Reservation supports for requested VM size.
NOTE: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation.
Minimum api-version: 2022-08-01."
+ },
+ "virtualMachinesAssociated": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of all virtual machine resource ids that are associated with the capacity reservation."
+ },
+ "provisioningTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The date time when the capacity reservation was last updated."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/CapacityReservationInstanceView",
+ "readOnly": true,
+ "description": "The Capacity reservation instance view."
+ },
+ "timeCreated": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the time at which the Capacity Reservation resource was created.
Minimum api-version: 2021-11-01."
+ }
+ },
+ "description": "Properties of the Capacity reservation."
+ },
+ "CapacityReservation": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CapacityReservationProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "required": [
+ "sku"
+ ],
+ "description": "Specifies information about the capacity reservation."
+ },
+ "CapacityReservationUpdate": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/CapacityReservationProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the capacity reservation. Only tags and sku.capacity can be updated."
+ },
+ "CapacityReservationListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CapacityReservation"
+ },
+ "description": "The list of capacity reservations"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The list capacity reservation operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/computeRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/computeRPCommon.json
new file mode 100644
index 000000000000..45aecf6c44f2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/computeRPCommon.json
@@ -0,0 +1,1905 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.Compute/operations": {
+ "get": {
+ "tags": [
+ "ComputeOperations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Gets a list of compute operations.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ComputeOperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "Operations_List_MaximumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json"
+ },
+ "Operations_List_MinimumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": {
+ "get": {
+ "tags": [
+ "Usage"
+ ],
+ "operationId": "Usage_List",
+ "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location for which resource usage is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ListUsagesResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Usage_List_MaximumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json"
+ },
+ "Usage_List_MinimumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": {
+ "get": {
+ "tags": [
+ "VirtualMachineSizes"
+ ],
+ "operationId": "VirtualMachineSizes_List",
+ "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location upon which virtual-machine-sizes is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineSizeListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "VirtualMachineSizes_List_MaximumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineSizes_List_MinimumSet_Gen": {
+ "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ComputeOperationListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ComputeOperationValue"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The list of compute operations"
+ }
+ },
+ "description": "The List Compute Operation operation response."
+ },
+ "ComputeOperationValue": {
+ "properties": {
+ "origin": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The origin of the compute operation."
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the compute operation."
+ },
+ "display": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ComputeOperationValueDisplay"
+ }
+ },
+ "description": "Describes the properties of a Compute Operation value."
+ },
+ "ComputeOperationValueDisplay": {
+ "properties": {
+ "operation": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The display name of the compute operation."
+ },
+ "resource": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The display name of the resource the operation applies to."
+ },
+ "description": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The description of the operation."
+ },
+ "provider": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The resource provider for the operation."
+ }
+ },
+ "description": "Describes the properties of a Compute Operation Value Display."
+ },
+ "UsageName": {
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "localizedValue": {
+ "type": "string",
+ "description": "The localized name of the resource."
+ }
+ },
+ "description": "The Usage Names."
+ },
+ "Usage": {
+ "properties": {
+ "unit": {
+ "type": "string",
+ "description": "An enum describing the unit of usage measurement.",
+ "enum": [
+ "Count"
+ ],
+ "x-ms-enum": {
+ "name": "UsageUnit",
+ "modelAsString": false
+ }
+ },
+ "currentValue": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The current usage of the resource."
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum permitted usage of the resource."
+ },
+ "name": {
+ "$ref": "#/definitions/UsageName",
+ "description": "The name of the type of usage."
+ }
+ },
+ "required": [
+ "unit",
+ "currentValue",
+ "limit",
+ "name"
+ ],
+ "description": "Describes Compute Resource Usage."
+ },
+ "ListUsagesResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Usage"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of compute resource usages."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Usages operation response."
+ },
+ "HyperVGenerationType": {
+ "type": "string",
+ "description": "Specifies the HyperVGeneration Type",
+ "enum": [
+ "V1",
+ "V2"
+ ],
+ "x-ms-enum": {
+ "name": "HyperVGenerationTypes",
+ "modelAsString": true
+ }
+ },
+ "InstanceViewStatus": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "The status code."
+ },
+ "level": {
+ "type": "string",
+ "description": "The level code.",
+ "enum": [
+ "Info",
+ "Warning",
+ "Error"
+ ],
+ "x-ms-enum": {
+ "name": "StatusLevelTypes",
+ "modelAsString": false
+ }
+ },
+ "displayStatus": {
+ "type": "string",
+ "description": "The short localizable label for the status."
+ },
+ "message": {
+ "type": "string",
+ "description": "The detailed status message, including for alerts and error messages."
+ },
+ "time": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time of the status."
+ }
+ },
+ "description": "Instance view status."
+ },
+ "SubResourceWithColocationStatus": {
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "properties": {
+ "colocationStatus": {
+ "$ref": "#/definitions/InstanceViewStatus",
+ "description": "Describes colocation status of a resource in the Proximity Placement Group."
+ }
+ }
+ },
+ "VirtualMachineSize": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the virtual machine size."
+ },
+ "numberOfCores": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list"
+ },
+ "osDiskSizeInMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The OS disk size, in MB, allowed by the virtual machine size."
+ },
+ "resourceDiskSizeInMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The resource disk size, in MB, allowed by the virtual machine size."
+ },
+ "memoryInMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The amount of memory, in MB, supported by the virtual machine size."
+ },
+ "maxDataDiskCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of data disks that can be attached to the virtual machine size."
+ }
+ },
+ "description": "Describes the properties of a VM size."
+ },
+ "VirtualMachineSizeListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineSize"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The list of virtual machine sizes."
+ }
+ },
+ "description": "The List Virtual Machine operation response."
+ },
+ "Plan": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The plan ID."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The publisher ID."
+ },
+ "product": {
+ "type": "string",
+ "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
+ },
+ "promotionCode": {
+ "type": "string",
+ "description": "The promotion code."
+ }
+ },
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "HardwareProfile": {
+ "properties": {
+ "vmSize": {
+ "type": "string",
+ "description": "Specifies the size of the virtual machine.
The enum data type is currently deprecated and will be removed by December 23rd 2023.
Recommended way to get the list of available sizes is using these APIs:
[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)
[List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list)
[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).
The available VM sizes depend on region and availability set.",
+ "enum": [
+ "Basic_A0",
+ "Basic_A1",
+ "Basic_A2",
+ "Basic_A3",
+ "Basic_A4",
+ "Standard_A0",
+ "Standard_A1",
+ "Standard_A2",
+ "Standard_A3",
+ "Standard_A4",
+ "Standard_A5",
+ "Standard_A6",
+ "Standard_A7",
+ "Standard_A8",
+ "Standard_A9",
+ "Standard_A10",
+ "Standard_A11",
+ "Standard_A1_v2",
+ "Standard_A2_v2",
+ "Standard_A4_v2",
+ "Standard_A8_v2",
+ "Standard_A2m_v2",
+ "Standard_A4m_v2",
+ "Standard_A8m_v2",
+ "Standard_B1s",
+ "Standard_B1ms",
+ "Standard_B2s",
+ "Standard_B2ms",
+ "Standard_B4ms",
+ "Standard_B8ms",
+ "Standard_D1",
+ "Standard_D2",
+ "Standard_D3",
+ "Standard_D4",
+ "Standard_D11",
+ "Standard_D12",
+ "Standard_D13",
+ "Standard_D14",
+ "Standard_D1_v2",
+ "Standard_D2_v2",
+ "Standard_D3_v2",
+ "Standard_D4_v2",
+ "Standard_D5_v2",
+ "Standard_D2_v3",
+ "Standard_D4_v3",
+ "Standard_D8_v3",
+ "Standard_D16_v3",
+ "Standard_D32_v3",
+ "Standard_D64_v3",
+ "Standard_D2s_v3",
+ "Standard_D4s_v3",
+ "Standard_D8s_v3",
+ "Standard_D16s_v3",
+ "Standard_D32s_v3",
+ "Standard_D64s_v3",
+ "Standard_D11_v2",
+ "Standard_D12_v2",
+ "Standard_D13_v2",
+ "Standard_D14_v2",
+ "Standard_D15_v2",
+ "Standard_DS1",
+ "Standard_DS2",
+ "Standard_DS3",
+ "Standard_DS4",
+ "Standard_DS11",
+ "Standard_DS12",
+ "Standard_DS13",
+ "Standard_DS14",
+ "Standard_DS1_v2",
+ "Standard_DS2_v2",
+ "Standard_DS3_v2",
+ "Standard_DS4_v2",
+ "Standard_DS5_v2",
+ "Standard_DS11_v2",
+ "Standard_DS12_v2",
+ "Standard_DS13_v2",
+ "Standard_DS14_v2",
+ "Standard_DS15_v2",
+ "Standard_DS13-4_v2",
+ "Standard_DS13-2_v2",
+ "Standard_DS14-8_v2",
+ "Standard_DS14-4_v2",
+ "Standard_E2_v3",
+ "Standard_E4_v3",
+ "Standard_E8_v3",
+ "Standard_E16_v3",
+ "Standard_E32_v3",
+ "Standard_E64_v3",
+ "Standard_E2s_v3",
+ "Standard_E4s_v3",
+ "Standard_E8s_v3",
+ "Standard_E16s_v3",
+ "Standard_E32s_v3",
+ "Standard_E64s_v3",
+ "Standard_E32-16_v3",
+ "Standard_E32-8s_v3",
+ "Standard_E64-32s_v3",
+ "Standard_E64-16s_v3",
+ "Standard_F1",
+ "Standard_F2",
+ "Standard_F4",
+ "Standard_F8",
+ "Standard_F16",
+ "Standard_F1s",
+ "Standard_F2s",
+ "Standard_F4s",
+ "Standard_F8s",
+ "Standard_F16s",
+ "Standard_F2s_v2",
+ "Standard_F4s_v2",
+ "Standard_F8s_v2",
+ "Standard_F16s_v2",
+ "Standard_F32s_v2",
+ "Standard_F64s_v2",
+ "Standard_F72s_v2",
+ "Standard_G1",
+ "Standard_G2",
+ "Standard_G3",
+ "Standard_G4",
+ "Standard_G5",
+ "Standard_GS1",
+ "Standard_GS2",
+ "Standard_GS3",
+ "Standard_GS4",
+ "Standard_GS5",
+ "Standard_GS4-8",
+ "Standard_GS4-4",
+ "Standard_GS5-16",
+ "Standard_GS5-8",
+ "Standard_H8",
+ "Standard_H16",
+ "Standard_H8m",
+ "Standard_H16m",
+ "Standard_H16r",
+ "Standard_H16mr",
+ "Standard_L4s",
+ "Standard_L8s",
+ "Standard_L16s",
+ "Standard_L32s",
+ "Standard_M64s",
+ "Standard_M64ms",
+ "Standard_M128s",
+ "Standard_M128ms",
+ "Standard_M64-32ms",
+ "Standard_M64-16ms",
+ "Standard_M128-64ms",
+ "Standard_M128-32ms",
+ "Standard_NC6",
+ "Standard_NC12",
+ "Standard_NC24",
+ "Standard_NC24r",
+ "Standard_NC6s_v2",
+ "Standard_NC12s_v2",
+ "Standard_NC24s_v2",
+ "Standard_NC24rs_v2",
+ "Standard_NC6s_v3",
+ "Standard_NC12s_v3",
+ "Standard_NC24s_v3",
+ "Standard_NC24rs_v3",
+ "Standard_ND6s",
+ "Standard_ND12s",
+ "Standard_ND24s",
+ "Standard_ND24rs",
+ "Standard_NV6",
+ "Standard_NV12",
+ "Standard_NV24"
+ ],
+ "x-ms-enum": {
+ "name": "VirtualMachineSizeTypes",
+ "modelAsString": true
+ }
+ },
+ "vmSizeProperties": {
+ "$ref": "#/definitions/VMSizeProperties",
+ "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01.
This feature is still in preview mode and is not supported for VirtualMachineScaleSet.
Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details."
+ }
+ },
+ "description": "Specifies the hardware settings for the virtual machine."
+ },
+ "VMSizeProperties": {
+ "type": "object",
+ "properties": {
+ "vCPUsAvailable": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the number of vCPUs available for the VM.
When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) ."
+ },
+ "vCPUsPerCore": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the vCPU to physical core ratio.
When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)
Setting this property to 1 also means that hyper-threading is disabled."
+ }
+ },
+ "description": "Specifies VM Size Property settings on the virtual machine."
+ },
+ "ImageReference": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "description": "The image publisher."
+ },
+ "offer": {
+ "type": "string",
+ "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine."
+ },
+ "sku": {
+ "type": "string",
+ "description": "The image SKU."
+ },
+ "version": {
+ "type": "string",
+ "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input."
+ },
+ "exactVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'."
+ },
+ "sharedGalleryImageId": {
+ "type": "string",
+ "description": "Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call."
+ },
+ "communityGalleryImageId": {
+ "type": "string",
+ "description": "Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set."
+ },
+ "DiskControllerType": {
+ "type": "string",
+ "enum": [
+ "SCSI",
+ "NVMe"
+ ],
+ "x-ms-enum": {
+ "name": "DiskControllerTypes",
+ "modelAsString": true
+ },
+ "description": "Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list) .
For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes."
+ },
+ "KeyVaultSecretReference": {
+ "properties": {
+ "secretUrl": {
+ "type": "string",
+ "description": "The URL referencing a secret in a Key Vault."
+ },
+ "sourceVault": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The relative URL of the Key Vault containing the secret."
+ }
+ },
+ "required": [
+ "secretUrl",
+ "sourceVault"
+ ],
+ "description": "Describes a reference to Key Vault Secret"
+ },
+ "DiskEncryptionSetParameters": {
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.
NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details."
+ },
+ "KeyVaultKeyReference": {
+ "properties": {
+ "keyUrl": {
+ "type": "string",
+ "description": "The URL referencing a key encryption key in Key Vault."
+ },
+ "sourceVault": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The relative URL of the Key Vault containing the key."
+ }
+ },
+ "required": [
+ "keyUrl",
+ "sourceVault"
+ ],
+ "description": "Describes a reference to Key Vault Key"
+ },
+ "DiskEncryptionSettings": {
+ "properties": {
+ "diskEncryptionKey": {
+ "$ref": "#/definitions/KeyVaultSecretReference",
+ "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret."
+ },
+ "keyEncryptionKey": {
+ "$ref": "#/definitions/KeyVaultKeyReference",
+ "description": "Specifies the location of the key encryption key in Key Vault."
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Specifies whether disk encryption should be enabled on the virtual machine."
+ }
+ },
+ "description": "Describes a Encryption Settings for a Disk"
+ },
+ "VMDiskSecurityProfile": {
+ "type": "object",
+ "properties": {
+ "securityEncryptionType": {
+ "type": "string",
+ "description": "Specifies the EncryptionType of the managed disk.
It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob.
NOTE: It can be set for only Confidential VMs.",
+ "enum": [
+ "VMGuestStateOnly",
+ "DiskWithVMGuestState"
+ ],
+ "x-ms-enum": {
+ "name": "securityEncryptionTypes",
+ "modelAsString": true
+ }
+ },
+ "diskEncryptionSet": {
+ "$ref": "#/definitions/DiskEncryptionSetParameters",
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob."
+ }
+ },
+ "description": "Specifies the security profile settings for the managed disk.
NOTE: It can only be set for Confidential VMs"
+ },
+ "VirtualHardDisk": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "Specifies the virtual hard disk's uri."
+ }
+ },
+ "description": "Describes the uri of a disk."
+ },
+ "Caching": {
+ "type": "string",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None for Standard storage. ReadOnly for Premium storage**",
+ "enum": [
+ "None",
+ "ReadOnly",
+ "ReadWrite"
+ ],
+ "x-ms-enum": {
+ "name": "CachingTypes",
+ "modelAsString": false
+ }
+ },
+ "CreateOption": {
+ "type": "string",
+ "description": "Specifies how the virtual machine should be created.
Possible values are:
**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.
**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.",
+ "enum": [
+ "FromImage",
+ "Empty",
+ "Attach"
+ ],
+ "x-ms-enum": {
+ "name": "DiskCreateOptionTypes",
+ "modelAsString": true
+ }
+ },
+ "DetachOption": {
+ "type": "string",
+ "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.
detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.
This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.",
+ "enum": [
+ "ForceDetach"
+ ],
+ "x-ms-enum": {
+ "name": "DiskDetachOptionTypes",
+ "modelAsString": true
+ }
+ },
+ "DeleteOption": {
+ "type": "string",
+ "description": "Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:
**Delete** If this value is used, the managed disk is deleted when VM gets deleted.
**Detach** If this value is used, the managed disk is retained after VM gets deleted.
Minimum api-version: 2021-03-01",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DiskDeleteOptionTypes",
+ "modelAsString": true
+ }
+ },
+ "StorageAccountType": {
+ "type": "string",
+ "description": "Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types",
+ "enum": [
+ "Standard_LRS",
+ "Premium_LRS",
+ "StandardSSD_LRS",
+ "UltraSSD_LRS",
+ "Premium_ZRS",
+ "StandardSSD_ZRS",
+ "PremiumV2_LRS"
+ ],
+ "x-ms-enum": {
+ "name": "StorageAccountTypes",
+ "modelAsString": true
+ }
+ },
+ "DiffDiskOption": {
+ "type": "string",
+ "description": "Specifies the ephemeral disk option for operating system disk.",
+ "enum": [
+ "Local"
+ ],
+ "x-ms-enum": {
+ "name": "DiffDiskOptions",
+ "modelAsString": true
+ }
+ },
+ "DiffDiskPlacement": {
+ "type": "string",
+ "description": "Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements",
+ "enum": [
+ "CacheDisk",
+ "ResourceDisk"
+ ],
+ "x-ms-enum": {
+ "name": "DiffDiskPlacement",
+ "modelAsString": true
+ }
+ },
+ "DiffDiskSettings": {
+ "properties": {
+ "option": {
+ "$ref": "#/definitions/DiffDiskOption",
+ "description": "Specifies the ephemeral disk settings for operating system disk."
+ },
+ "placement": {
+ "$ref": "#/definitions/DiffDiskPlacement",
+ "description": "Specifies the ephemeral disk placement for operating system disk.
Possible values are:
**CacheDisk**
**ResourceDisk**
Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.
Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk."
+ }
+ },
+ "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.
NOTE: The ephemeral disk settings can only be specified for managed disk."
+ },
+ "ManagedDiskParameters": {
+ "properties": {
+ "storageAccountType": {
+ "$ref": "#/definitions/StorageAccountType",
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "$ref": "#/definitions/DiskEncryptionSetParameters",
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk."
+ },
+ "securityProfile": {
+ "$ref": "#/definitions/VMDiskSecurityProfile",
+ "description": "Specifies the security profile for the managed disk."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "The parameters of a managed disk."
+ },
+ "OSDisk": {
+ "properties": {
+ "osType": {
+ "type": "string",
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
Possible values are:
**Windows**
**Linux**",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemTypes",
+ "modelAsString": false
+ }
+ },
+ "encryptionSettings": {
+ "$ref": "#/definitions/DiskEncryptionSettings",
+ "description": "Specifies the encryption settings for the OS Disk.
Minimum api-version: 2015-06-15"
+ },
+ "name": {
+ "type": "string",
+ "description": "The disk name."
+ },
+ "vhd": {
+ "$ref": "#/definitions/VirtualHardDisk",
+ "description": "The virtual hard disk."
+ },
+ "image": {
+ "$ref": "#/definitions/VirtualHardDisk",
+ "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
+ },
+ "caching": {
+ "$ref": "#/definitions/Caching",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None** for Standard storage. **ReadOnly** for Premium storage."
+ },
+ "writeAcceleratorEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "diffDiskSettings": {
+ "$ref": "#/definitions/DiffDiskSettings",
+ "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine."
+ },
+ "createOption": {
+ "$ref": "#/definitions/CreateOption",
+ "description": "Specifies how the virtual machine should be created.
Possible values are:
**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.
**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
+ },
+ "managedDisk": {
+ "description": "The managed disk parameters.",
+ "$ref": "#/definitions/ManagedDiskParameters"
+ },
+ "deleteOption": {
+ "$ref": "#/definitions/DeleteOption",
+ "description": "Specifies whether OS Disk should be deleted or detached upon VM deletion.
Possible values:
**Delete** If this value is used, the OS disk is deleted when VM is deleted.
**Detach** If this value is used, the os disk is retained after VM is deleted.
The default value is set to **detach**. For an ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for ephemeral OS Disk."
+ }
+ },
+ "required": [
+ "createOption"
+ ],
+ "description": "Specifies information about the operating system disk used by the virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "DataDisk": {
+ "properties": {
+ "lun": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ },
+ "name": {
+ "type": "string",
+ "description": "The disk name."
+ },
+ "vhd": {
+ "$ref": "#/definitions/VirtualHardDisk",
+ "description": "The virtual hard disk."
+ },
+ "image": {
+ "$ref": "#/definitions/VirtualHardDisk",
+ "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
+ },
+ "caching": {
+ "$ref": "#/definitions/Caching",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None for Standard storage. ReadOnly for Premium storage**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "$ref": "#/definitions/CreateOption",
+ "description": "Specifies how the virtual machine should be created.
Possible values are:
**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.
**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
+ },
+ "managedDisk": {
+ "description": "The managed disk parameters.",
+ "$ref": "#/definitions/ManagedDiskParameters"
+ },
+ "toBeDetached": {
+ "type": "boolean",
+ "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset"
+ },
+ "diskIOPSReadWrite": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int64",
+ "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set."
+ },
+ "diskMBpsReadWrite": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int64",
+ "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set."
+ },
+ "detachOption": {
+ "$ref": "#/definitions/DetachOption",
+ "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**.
detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior.
This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'."
+ },
+ "deleteOption": {
+ "$ref": "#/definitions/DeleteOption",
+ "description": "Specifies whether data disk should be deleted or detached upon VM deletion.
Possible values:
**Delete** If this value is used, the data disk is deleted when VM is deleted.
**Detach** If this value is used, the data disk is retained after VM is deleted.
The default value is set to **detach**"
+ }
+ },
+ "required": [
+ "lun",
+ "createOption"
+ ],
+ "description": "Describes a data disk."
+ },
+ "CapacityReservationProfile": {
+ "type": "object",
+ "properties": {
+ "capacityReservationGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details."
+ }
+ },
+ "description": "The parameters of a capacity reservation Profile."
+ },
+ "StorageProfile": {
+ "properties": {
+ "imageReference": {
+ "$ref": "#/definitions/ImageReference",
+ "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations."
+ },
+ "osDisk": {
+ "$ref": "#/definitions/OSDisk",
+ "description": "Specifies information about the operating system disk used by the virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataDisk"
+ },
+ "x-ms-identifiers": [
+ "lun"
+ ],
+ "description": "Specifies the parameters that are used to add a data disk to a virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "diskControllerType": {
+ "$ref": "#/definitions/DiskControllerType",
+ "description": "Specifies the disk controller type configured for the VM.
NOTE: This property will be set to the default disk controller type if not specified provided virtual machine is being created as a hyperVGeneration: V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version.
You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM.
Minimum api-version: 2022-08-01"
+ }
+ },
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "UefiSettings": {
+ "properties": {
+ "secureBootEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether secure boot should be enabled on the virtual machine.
Minimum api-version: 2020-12-01"
+ },
+ "vTpmEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether vTPM should be enabled on the virtual machine.
Minimum api-version: 2020-12-01"
+ }
+ },
+ "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Minimum api-version: 2020-12-01"
+ },
+ "SecurityProfile": {
+ "properties": {
+ "uefiSettings": {
+ "$ref": "#/definitions/UefiSettings",
+ "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
Minimum api-version: 2020-12-01"
+ },
+ "encryptionAtHost": {
+ "type": "boolean",
+ "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.
Default: The Encryption at host will be disabled unless this property is set to true for the resource."
+ },
+ "securityType": {
+ "type": "string",
+ "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
Default: UefiSettings will not be enabled unless this property is set.",
+ "enum": [
+ "TrustedLaunch",
+ "ConfidentialVM"
+ ],
+ "x-ms-enum": {
+ "name": "SecurityTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set."
+ },
+ "VMGalleryApplication": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "string",
+ "description": "Optional, Specifies a passthrough value for more generic context."
+ },
+ "order": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Optional, Specifies the order in which the packages have to be installed"
+ },
+ "packageReferenceId": {
+ "type": "string",
+ "description": "Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}"
+ },
+ "configurationReference": {
+ "type": "string",
+ "description": "Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided"
+ },
+ "treatFailureAsDeploymentFailure": {
+ "type": "boolean",
+ "description": "Optional, If true, any failure for any operation in the VmApplication will fail the deployment"
+ },
+ "enableAutomaticUpgrade": {
+ "type": "boolean",
+ "description": "If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS"
+ }
+ },
+ "required": [
+ "packageReferenceId"
+ ],
+ "description": "Specifies the required information to reference a compute gallery application version"
+ },
+ "ApplicationProfile": {
+ "type": "object",
+ "properties": {
+ "galleryApplications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VMGalleryApplication"
+ },
+ "x-ms-identifiers": [
+ "packageReferenceId"
+ ],
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS"
+ }
+ },
+ "description": "Contains the list of gallery applications that should be made available to the VM/VMSS"
+ },
+ "AdditionalCapabilities": {
+ "properties": {
+ "ultraSSDEnabled": {
+ "type": "boolean",
+ "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled."
+ },
+ "hibernationEnabled": {
+ "type": "boolean",
+ "description": "The flag that enables or disables hibernation capability on the VM."
+ }
+ },
+ "description": "Enables or disables a capability on the virtual machine or virtual machine scale set."
+ },
+ "AdditionalUnattendContent": {
+ "properties": {
+ "passName": {
+ "type": "string",
+ "description": "The pass name. Currently, the only allowable value is OobeSystem.",
+ "enum": [
+ "OobeSystem"
+ ],
+ "x-ms-enum": {
+ "name": "PassNames",
+ "modelAsString": false
+ }
+ },
+ "componentName": {
+ "type": "string",
+ "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.",
+ "enum": [
+ "Microsoft-Windows-Shell-Setup"
+ ],
+ "x-ms-enum": {
+ "name": "ComponentNames",
+ "modelAsString": false
+ }
+ },
+ "settingName": {
+ "type": "string",
+ "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.",
+ "enum": [
+ "AutoLogon",
+ "FirstLogonCommands"
+ ],
+ "x-ms-enum": {
+ "name": "SettingNames",
+ "modelAsString": false
+ }
+ },
+ "content": {
+ "type": "string",
+ "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted."
+ }
+ },
+ "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied."
+ },
+ "WinRMListener": {
+ "properties": {
+ "protocol": {
+ "type": "string",
+ "description": "Specifies the protocol of WinRM listener.
Possible values are:
**http**
**https**",
+ "enum": [
+ "Http",
+ "Https"
+ ],
+ "x-ms-enum": {
+ "name": "ProtocolTypes",
+ "modelAsString": false
+ }
+ },
+ "certificateUrl": {
+ "type": "string",
+ "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ }
+ },
+ "description": "Describes Protocol and thumbprint of Windows Remote Management listener"
+ },
+ "WinRMConfiguration": {
+ "properties": {
+ "listeners": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WinRMListener"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of Windows Remote Management listeners"
+ }
+ },
+ "description": "Describes Windows Remote Management configuration of the VM"
+ },
+ "WindowsConfiguration": {
+ "properties": {
+ "provisionVMAgent": {
+ "type": "boolean",
+ "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.
When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later."
+ },
+ "enableAutomaticUpdates": {
+ "type": "boolean",
+ "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.
For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning."
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".
Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)."
+ },
+ "additionalUnattendContent": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AdditionalUnattendContent"
+ },
+ "x-ms-identifiers": [],
+ "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup."
+ },
+ "patchSettings": {
+ "$ref": "#/definitions/PatchSettings",
+ "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows."
+ },
+ "winRM": {
+ "$ref": "#/definitions/WinRMConfiguration",
+ "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell."
+ },
+ "enableVMAgentPlatformUpdates": {
+ "type": "boolean",
+ "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false."
+ }
+ },
+ "description": "Specifies Windows operating system settings on the virtual machine."
+ },
+ "SshPublicKey": {
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys"
+ },
+ "keyData": {
+ "type": "string",
+ "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.
For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)."
+ }
+ },
+ "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed."
+ },
+ "SshConfiguration": {
+ "properties": {
+ "publicKeys": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SshPublicKey"
+ },
+ "x-ms-identifiers": [
+ "path"
+ ],
+ "description": "The list of SSH public keys used to authenticate with linux based VMs."
+ }
+ },
+ "description": "SSH configuration for Linux based VMs running on Azure"
+ },
+ "LinuxConfiguration": {
+ "properties": {
+ "disablePasswordAuthentication": {
+ "type": "boolean",
+ "description": "Specifies whether password authentication should be disabled."
+ },
+ "ssh": {
+ "$ref": "#/definitions/SshConfiguration",
+ "description": "Specifies the ssh key configuration for a Linux OS."
+ },
+ "provisionVMAgent": {
+ "type": "boolean",
+ "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.
When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later."
+ },
+ "patchSettings": {
+ "$ref": "#/definitions/LinuxPatchSettings",
+ "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux."
+ },
+ "enableVMAgentPlatformUpdates": {
+ "type": "boolean",
+ "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false."
+ }
+ },
+ "description": "Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
+ },
+ "VaultCertificate": {
+ "properties": {
+ "certificateUrl": {
+ "type": "string",
+ "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "certificateStore": {
+ "type": "string",
+ "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.
For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted."
+ }
+ },
+ "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM."
+ },
+ "VaultSecretGroup": {
+ "properties": {
+ "sourceVault": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates."
+ },
+ "vaultCertificates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VaultCertificate"
+ },
+ "x-ms-identifiers": [
+ "certificateUrl"
+ ],
+ "description": "The list of key vault references in SourceVault which contain certificates."
+ }
+ },
+ "description": "Describes a set of certificates which are all in the same Key Vault."
+ },
+ "OSProfile": {
+ "properties": {
+ "computerName": {
+ "type": "string",
+ "description": "Specifies the host OS name of the virtual machine.
This name cannot be updated after the VM is created.
**Max-length (Windows):** 15 characters
**Max-length (Linux):** 64 characters.
For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules)."
+ },
+ "adminUsername": {
+ "type": "string",
+ "description": "Specifies the name of the administrator account.
This property cannot be updated after the VM is created.
**Windows-only restriction:** Cannot end in \".\"
**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".
**Minimum-length (Linux):** 1 character
**Max-length (Linux):** 64 characters
**Max-length (Windows):** 20 characters."
+ },
+ "adminPassword": {
+ "type": "string",
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)",
+ "x-ms-secret": true
+ },
+ "customData": {
+ "type": "string",
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
**Note: Do not pass any secrets or passwords in customData property**
This property cannot be updated after the VM is created.
customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)
For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)"
+ },
+ "windowsConfiguration": {
+ "$ref": "#/definitions/WindowsConfiguration",
+ "description": "Specifies Windows operating system settings on the virtual machine."
+ },
+ "linuxConfiguration": {
+ "$ref": "#/definitions/LinuxConfiguration",
+ "description": "Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VaultSecretGroup"
+ },
+ "x-ms-identifiers": [
+ "sourceVault/id"
+ ],
+ "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "allowExtensionOperations": {
+ "type": "boolean",
+ "description": "Specifies whether extension operations should be allowed on the virtual machine.
This may only be set to False when no extensions are present on the virtual machine."
+ },
+ "requireGuestProvisionSignal": {
+ "type": "boolean",
+ "description": "Optional property which must either be set to True or omitted."
+ }
+ },
+ "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned."
+ },
+ "NetworkInterfaceReferenceProperties": {
+ "properties": {
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the network interface when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a network interface reference properties."
+ },
+ "NetworkInterfaceReference": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/NetworkInterfaceReferenceProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes a network interface reference."
+ },
+ "PublicIPAddressSku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Specify public IP sku name",
+ "enum": [
+ "Basic",
+ "Standard"
+ ],
+ "x-ms-enum": {
+ "name": "PublicIPAddressSkuName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "type": "string",
+ "description": "Specify public IP sku tier",
+ "enum": [
+ "Regional",
+ "Global"
+ ],
+ "x-ms-enum": {
+ "name": "PublicIPAddressSkuTier",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible."
+ },
+ "NetworkProfile": {
+ "properties": {
+ "networkInterfaces": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkInterfaceReference"
+ },
+ "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine."
+ },
+ "networkApiVersion": {
+ "type": "string",
+ "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations",
+ "enum": [
+ "2020-11-01"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkApiVersion",
+ "modelAsString": true
+ }
+ },
+ "networkInterfaceConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineNetworkInterfaceConfiguration"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "Specifies the networking configurations that will be used to create the virtual machine networking resources."
+ }
+ },
+ "description": "Specifies the network interfaces or the networking configuration of the virtual machine."
+ },
+ "BootDiagnostics": {
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether boot diagnostics should be enabled on the Virtual Machine."
+ },
+ "storageUri": {
+ "type": "string",
+ "description": "Uri of the storage account to use for placing the console output and screenshot.
If storageUri is not specified while enabling boot diagnostics, managed storage will be used."
+ }
+ },
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor."
+ },
+ "DiagnosticsProfile": {
+ "properties": {
+ "bootDiagnostics": {
+ "$ref": "#/definitions/BootDiagnostics",
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
**NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor."
+ }
+ },
+ "description": "Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15."
+ },
+ "priority": {
+ "type": "string",
+ "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.
'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.",
+ "enum": [
+ "Regular",
+ "Low",
+ "Spot"
+ ],
+ "x-ms-enum": {
+ "name": "VirtualMachinePriorityTypes",
+ "modelAsString": true
+ }
+ },
+ "evictionPolicy": {
+ "type": "string",
+ "description": "Specifies the eviction policy for the Azure Spot VM/VMSS",
+ "enum": [
+ "Deallocate",
+ "Delete"
+ ],
+ "x-ms-enum": {
+ "name": "VirtualMachineEvictionPolicyTypes",
+ "modelAsString": true
+ }
+ },
+ "BillingProfile": {
+ "properties": {
+ "maxPrice": {
+ "type": "number",
+ "format": "double",
+ "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.
This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.
The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.
Possible values are:
- Any decimal value greater than zero. Example: 0.01538
-1 – indicates default price to be up-to on-demand.
You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.
Minimum api-version: 2019-03-01."
+ }
+ },
+ "description": "Specifies the billing related details of a Azure Spot VM or VMSS.
Minimum api-version: 2019-03-01."
+ },
+ "DiskInstanceView": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The disk name."
+ },
+ "encryptionSettings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiskEncryptionSettings"
+ },
+ "x-ms-identifiers": [
+ "diskEncryptionKey/sourceVault/id"
+ ],
+ "description": "Specifies the encryption settings for the OS Disk.
Minimum api-version: 2015-06-15"
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of the disk."
+ },
+ "BootDiagnosticsInstanceView": {
+ "properties": {
+ "consoleScreenshotBlobUri": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The console screenshot blob URI.
NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
+ },
+ "serialConsoleLogBlobUri": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The serial console log blob Uri.
NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage."
+ },
+ "status": {
+ "readOnly": true,
+ "$ref": "#/definitions/InstanceViewStatus",
+ "description": "The boot diagnostics status information for the VM.
NOTE: It will be set only if there are errors encountered in enabling boot diagnostics."
+ }
+ },
+ "description": "The instance view of a virtual machine boot diagnostics."
+ },
+ "MaintenanceRedeployStatus": {
+ "properties": {
+ "isCustomerInitiatedMaintenanceAllowed": {
+ "type": "boolean",
+ "description": "True, if customer is allowed to perform Maintenance."
+ },
+ "preMaintenanceWindowStartTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start Time for the Pre Maintenance Window."
+ },
+ "preMaintenanceWindowEndTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "End Time for the Pre Maintenance Window."
+ },
+ "maintenanceWindowStartTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start Time for the Maintenance Window."
+ },
+ "maintenanceWindowEndTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "End Time for the Maintenance Window."
+ },
+ "lastOperationResultCode": {
+ "type": "string",
+ "description": "The Last Maintenance Operation Result Code.",
+ "enum": [
+ "None",
+ "RetryLater",
+ "MaintenanceAborted",
+ "MaintenanceCompleted"
+ ],
+ "x-ms-enum": {
+ "name": "MaintenanceOperationResultCodeTypes",
+ "modelAsString": false
+ }
+ },
+ "lastOperationMessage": {
+ "type": "string",
+ "description": "Message returned for the last Maintenance Operation."
+ }
+ },
+ "description": "Maintenance Operation Status."
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The sku name."
+ },
+ "tier": {
+ "type": "string",
+ "description": "Specifies the tier of virtual machines in a scale set.
Possible Values:
**Standard**
**Basic**"
+ },
+ "capacity": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Specifies the number of virtual machines in the scale set."
+ }
+ },
+ "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name."
+ },
+ "ApiEntityReference": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..."
+ }
+ },
+ "description": "The API entity reference."
+ },
+ "RollbackStatusInfo": {
+ "properties": {
+ "successfullyRolledbackInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances which have been successfully rolled back."
+ },
+ "failedRolledbackInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances which failed to rollback."
+ },
+ "rollbackError": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "Error details if OS rollback failed."
+ }
+ },
+ "description": "Information about rollback on failed VM instances after a OS Upgrade operation."
+ },
+ "ScheduledEventsProfile": {
+ "type": "object",
+ "properties": {
+ "terminateNotificationProfile": {
+ "$ref": "#/definitions/TerminateNotificationProfile",
+ "description": "Specifies Terminate Scheduled Event related configurations."
+ },
+ "osImageNotificationProfile": {
+ "$ref": "#/definitions/OSImageNotificationProfile",
+ "description": "Specifies OS Image Scheduled Event related configurations."
+ }
+ }
+ },
+ "TerminateNotificationProfile": {
+ "type": "object",
+ "properties": {
+ "notBeforeTimeout": {
+ "type": "string",
+ "description": "Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)"
+ },
+ "enable": {
+ "type": "boolean",
+ "description": "Specifies whether the Terminate Scheduled event is enabled or disabled."
+ }
+ }
+ },
+ "OSImageNotificationProfile": {
+ "type": "object",
+ "properties": {
+ "notBeforeTimeout": {
+ "type": "string",
+ "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M)"
+ },
+ "enable": {
+ "type": "boolean",
+ "description": "Specifies whether the OS Image Scheduled event is enabled or disabled."
+ }
+ }
+ },
+ "ProxyResource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource Id"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ }
+ },
+ "description": "The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location",
+ "x-ms-azure-resource": true
+ },
+ "UpdateResource": {
+ "description": "The Update Resource model definition.",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ }
+ }
+ },
+ "PatchSettings": {
+ "properties": {
+ "patchMode": {
+ "type": "string",
+ "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false
**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.
**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ",
+ "enum": [
+ "Manual",
+ "AutomaticByOS",
+ "AutomaticByPlatform"
+ ],
+ "x-ms-enum": {
+ "name": "WindowsVMGuestPatchMode",
+ "modelAsString": true
+ }
+ },
+ "enableHotpatching": {
+ "type": "boolean",
+ "description": "Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'."
+ },
+ "assessmentMode": {
+ "type": "string",
+ "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
Possible values are:
**ImageDefault** - You control the timing of patch assessments on a virtual machine.
**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. ",
+ "enum": [
+ "ImageDefault",
+ "AutomaticByPlatform"
+ ],
+ "x-ms-enum": {
+ "name": "WindowsPatchAssessmentMode",
+ "modelAsString": true
+ }
+ },
+ "automaticByPlatformSettings": {
+ "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings",
+ "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows."
+ }
+ },
+ "description": "Specifies settings related to VM Guest Patching on Windows."
+ },
+ "LinuxPatchSettings": {
+ "properties": {
+ "patchMode": {
+ "type": "string",
+ "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
**ImageDefault** - The virtual machine's default patching configuration is used.
**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true",
+ "enum": [
+ "ImageDefault",
+ "AutomaticByPlatform"
+ ],
+ "x-ms-enum": {
+ "name": "LinuxVMGuestPatchMode",
+ "modelAsString": true
+ }
+ },
+ "assessmentMode": {
+ "type": "string",
+ "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.
Possible values are:
**ImageDefault** - You control the timing of patch assessments on a virtual machine.
**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.",
+ "enum": [
+ "ImageDefault",
+ "AutomaticByPlatform"
+ ],
+ "x-ms-enum": {
+ "name": "LinuxPatchAssessmentMode",
+ "modelAsString": true
+ }
+ },
+ "automaticByPlatformSettings": {
+ "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings",
+ "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux."
+ }
+ },
+ "description": "Specifies settings related to VM Guest Patching on Linux."
+ },
+ "WindowsVMGuestPatchAutomaticByPlatformSettings": {
+ "type": "object",
+ "properties": {
+ "rebootSetting": {
+ "type": "string",
+ "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.",
+ "enum": [
+ "Unknown",
+ "IfRequired",
+ "Never",
+ "Always"
+ ],
+ "x-ms-enum": {
+ "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings."
+ },
+ "LinuxVMGuestPatchAutomaticByPlatformSettings": {
+ "type": "object",
+ "properties": {
+ "rebootSetting": {
+ "type": "string",
+ "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.",
+ "enum": [
+ "Unknown",
+ "IfRequired",
+ "Never",
+ "Always"
+ ],
+ "x-ms-enum": {
+ "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/dedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/dedicatedHost.json
new file mode 100644
index 000000000000..a3ece61a6d90
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/dedicatedHost.json
@@ -0,0 +1,1061 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": {
+ "put": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_CreateOrUpdate",
+ "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ },
+ "description": "Parameters supplied to the Create Dedicated Host Group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a dedicated host group.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json"
+ },
+ "Create or update a dedicated host group with Ultra SSD support.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_Update",
+ "description": "Update an dedicated host group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroupUpdate"
+ },
+ "description": "Parameters supplied to the Update Dedicated Host Group operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DedicatedHostGroups_Update_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_Update_MaximumSet_Gen.json"
+ },
+ "DedicatedHostGroups_Update_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_Delete",
+ "description": "Delete a dedicated host group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DedicatedHostGroups_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MaximumSet_Gen.json"
+ },
+ "DedicatedHostGroups_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_Get",
+ "description": "Retrieves information about a dedicated host group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.",
+ "enum": [
+ "instanceView",
+ "userData"
+ ],
+ "x-ms-enum": {
+ "name": "InstanceViewTypes",
+ "modelAsString": false
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a dedicated host group.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get.json"
+ },
+ "Create an ultraSSDEnabled dedicated host group.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": {
+ "get": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_ListByResourceGroup",
+ "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DedicatedHostGroups_ListByResourceGroup_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MaximumSet_Gen.json"
+ },
+ "DedicatedHostGroups_ListByResourceGroup_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": {
+ "get": {
+ "tags": [
+ "DedicatedHostGroups"
+ ],
+ "operationId": "DedicatedHostGroups_ListBySubscription",
+ "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DedicatedHostGroups_ListBySubscription_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MaximumSet_Gen.json"
+ },
+ "DedicatedHostGroups_ListBySubscription_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": {
+ "put": {
+ "tags": [
+ "DedicatedHosts"
+ ],
+ "operationId": "DedicatedHosts_CreateOrUpdate",
+ "description": "Create or update a dedicated host .",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host ."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DedicatedHost"
+ },
+ "description": "Parameters supplied to the Create Dedicated Host."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHost"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHost"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a dedicated host .": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "DedicatedHosts"
+ ],
+ "operationId": "DedicatedHosts_Update",
+ "description": "Update an dedicated host .",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host ."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostUpdate"
+ },
+ "description": "Parameters supplied to the Update Dedicated Host operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHost"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DedicatedHosts_Update_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_Update_MaximumSet_Gen.json"
+ },
+ "DedicatedHosts_Update_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DedicatedHosts"
+ ],
+ "operationId": "DedicatedHosts_Delete",
+ "description": "Delete a dedicated host.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DedicatedHosts_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_Delete_MaximumSet_Gen.json"
+ },
+ "DedicatedHosts_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "DedicatedHosts"
+ ],
+ "operationId": "DedicatedHosts_Get",
+ "description": "Retrieves information about a dedicated host.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.",
+ "enum": [
+ "instanceView",
+ "userData"
+ ],
+ "x-ms-enum": {
+ "name": "InstanceViewTypes",
+ "modelAsString": false
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHost"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a dedicated host.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": {
+ "get": {
+ "tags": [
+ "DedicatedHost"
+ ],
+ "operationId": "DedicatedHosts_ListByHostGroup",
+ "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DedicatedHostListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DedicatedHosts_ListByHostGroup_MaximumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MaximumSet_Gen.json"
+ },
+ "DedicatedHosts_ListByHostGroup_MinimumSet_Gen": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/restart": {
+ "post": {
+ "tags": [
+ "DedicatedHost"
+ ],
+ "operationId": "DedicatedHosts_Restart",
+ "description": "Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "hostGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host group."
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the dedicated host."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Restart Dedicated Host.": {
+ "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Restart.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DedicatedHostGroupInstanceView": {
+ "properties": {
+ "hosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DedicatedHostInstanceViewWithName"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "List of instance view of the dedicated hosts under the dedicated host group."
+ }
+ }
+ },
+ "DedicatedHostGroupProperties": {
+ "properties": {
+ "platformFaultDomainCount": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "description": "Number of fault domains that the host group can span."
+ },
+ "hosts": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of references to all dedicated hosts in the dedicated host group."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/DedicatedHostGroupInstanceView",
+ "readOnly": true,
+ "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group."
+ },
+ "supportAutomaticPlacement": {
+ "type": "boolean",
+ "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided.
Minimum api-version: 2020-06-01."
+ },
+ "additionalCapabilities": {
+ "type": "object",
+ "properties": {
+ "ultraSSDEnabled": {
+ "type": "boolean",
+ "description": "The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature.
NOTE: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal.
Minimum api-version: 2022-03-01."
+ }
+ },
+ "description": "Enables or disables a capability on the dedicated host group.
Minimum api-version: 2022-03-01."
+ }
+ },
+ "required": [
+ "platformFaultDomainCount"
+ ],
+ "description": "Dedicated Host Group Properties."
+ },
+ "DedicatedHostGroup": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DedicatedHostGroupProperties"
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.
Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group."
+ },
+ "DedicatedHostGroupUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DedicatedHostGroupProperties"
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated."
+ },
+ "DedicatedHostGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DedicatedHostGroup"
+ },
+ "description": "The list of dedicated host groups"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Dedicated Host Group with resource group response."
+ },
+ "DedicatedHostLicenseType": {
+ "type": "string",
+ "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.
Possible values are:
**None**
**Windows_Server_Hybrid**
**Windows_Server_Perpetual**
Default: **None**",
+ "enum": [
+ "None",
+ "Windows_Server_Hybrid",
+ "Windows_Server_Perpetual"
+ ],
+ "x-ms-enum": {
+ "name": "DedicatedHostLicenseTypes",
+ "modelAsString": false
+ }
+ },
+ "DedicatedHostAllocatableVM": {
+ "properties": {
+ "vmSize": {
+ "type": "string",
+ "description": "VM size in terms of which the unutilized capacity is represented."
+ },
+ "count": {
+ "type": "number",
+ "format": "double",
+ "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity."
+ }
+ },
+ "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size."
+ },
+ "DedicatedHostAvailableCapacity": {
+ "properties": {
+ "allocatableVMs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DedicatedHostAllocatableVM"
+ },
+ "x-ms-identifiers": [],
+ "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host."
+ }
+ },
+ "description": "Dedicated host unutilized capacity."
+ },
+ "DedicatedHostInstanceView": {
+ "properties": {
+ "assetId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides."
+ },
+ "availableCapacity": {
+ "$ref": "#/definitions/DedicatedHostAvailableCapacity",
+ "description": "Unutilized capacity of the dedicated host."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a dedicated host."
+ },
+ "DedicatedHostInstanceViewWithName": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the dedicated host."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DedicatedHostInstanceView"
+ }
+ ],
+ "description": "The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group."
+ },
+ "DedicatedHostProperties": {
+ "properties": {
+ "platformFaultDomain": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "description": "Fault domain of the dedicated host within a dedicated host group."
+ },
+ "autoReplaceOnFailure": {
+ "type": "boolean",
+ "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided."
+ },
+ "hostId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "A unique id generated and assigned to the dedicated host by the platform.
Does not change throughout the lifetime of the host."
+ },
+ "virtualMachines": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ },
+ "readOnly": true,
+ "description": "A list of references to all virtual machines in the Dedicated Host."
+ },
+ "licenseType": {
+ "$ref": "#/definitions/DedicatedHostLicenseType",
+ "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.
Possible values are:
**None**
**Windows_Server_Hybrid**
**Windows_Server_Perpetual**
Default: **None**"
+ },
+ "provisioningTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The date when the host was first provisioned."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/DedicatedHostInstanceView",
+ "readOnly": true,
+ "description": "The dedicated host instance view."
+ },
+ "timeCreated": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the time at which the Dedicated Host resource was created.
Minimum api-version: 2021-11-01."
+ }
+ },
+ "description": "Properties of the dedicated host."
+ },
+ "DedicatedHost": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DedicatedHostProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "required": [
+ "sku"
+ ],
+ "description": "Specifies information about the Dedicated host."
+ },
+ "DedicatedHostUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DedicatedHostProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated."
+ },
+ "DedicatedHostListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DedicatedHost"
+ },
+ "description": "The list of dedicated hosts"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The list dedicated host operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_Create.json
new file mode 100644
index 000000000000..becaac4a8a8a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_Create.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "availabilitySetName": "myAvailabilitySet",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "platformFaultDomainCount": 2,
+ "platformUpdateDomainCount": 20
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "name": "Classic"
+ },
+ "name": "myAvailabilitySet",
+ "properties": {
+ "platformFaultDomainCount": 2,
+ "platformUpdateDomainCount": 20
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/availabilitySets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json
new file mode 100644
index 000000000000..b39c982e15d8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "api-version": "2022-11-01",
+ "$expand": "virtualMachines\\$ref"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "australiasoutheast",
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic"
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "australiasoutheast",
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic"
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "westcentralus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": []
+ },
+ "sku": {
+ "name": "Classic"
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "westcentralus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": []
+ },
+ "sku": {
+ "name": "Classic"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..f61254958d65
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MaximumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..60059d9497ee
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Delete_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..612b859ee744
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MaximumSet_Gen.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "properties": {
+ "platformFaultDomainCount": 2,
+ "platformUpdateDomainCount": 20,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet",
+ "name": "myAvailabilitySet",
+ "type": "Microsoft.Compute/availabilitySets",
+ "tags": {
+ "key9626": "aaaaaaaaaaaaaaaaaaaa",
+ "key2505": "aa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..2422a5ba7779
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Get_MinimumSet_Gen.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MaximumSet_Gen.json
new file mode 100644
index 000000000000..f15a3b7101f8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MaximumSet_Gen.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Standard_A1_V2",
+ "numberOfCores": 1,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 10240,
+ "memoryInMB": 2048,
+ "maxDataDiskCount": 2
+ },
+ {
+ "name": "Standard_A2_V2",
+ "numberOfCores": 2,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 20480,
+ "memoryInMB": 4096,
+ "maxDataDiskCount": 4
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MinimumSet_Gen.json
new file mode 100644
index 000000000000..d5965f809b3d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_ListAvailableSizes_MinimumSet_Gen.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..ede9300bd534
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MaximumSet_Gen.json
@@ -0,0 +1,144 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "australiasoutheast",
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
+ }
+ ],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaa",
+ "message": "aaaaaa",
+ "time": "2021-11-30T13:39:56.427Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "capacity": 22
+ },
+ "tags": {
+ "key2039": "aaaaaaaaaaaaa"
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "australiasoutheast",
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}"
+ }
+ ],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaa",
+ "message": "aaaaaa",
+ "time": "2021-11-30T13:39:56.427Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "capacity": 23
+ },
+ "tags": {
+ "key5849": "aaaaaaaaaaaaaaa"
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "westcentralus",
+ "tags": {},
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaa",
+ "message": "aaaaaa",
+ "time": "2021-11-30T13:39:56.427Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaaaaaaaaa",
+ "capacity": 26
+ }
+ },
+ {
+ "name": "{availabilitySetName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}",
+ "type": "Microsoft.Compute/availabilitySets",
+ "location": "westcentralus",
+ "tags": {},
+ "properties": {
+ "platformUpdateDomainCount": 5,
+ "platformFaultDomainCount": 3,
+ "virtualMachines": [],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaa",
+ "message": "aaaaaa",
+ "time": "2021-11-30T13:39:56.427Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaaaaaa",
+ "capacity": 6
+ }
+ }
+ ],
+ "nextLink": "aaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..6a0f7e39cd43
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_List_MinimumSet_Gen.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "australiasoutheast"
+ },
+ {
+ "location": "australiasoutheast"
+ },
+ {
+ "location": "westcentralus"
+ },
+ {
+ "location": "westcentralus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..60ce2e5e0f03
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MaximumSet_Gen.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "platformFaultDomainCount": 2,
+ "platformUpdateDomainCount": 20,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "sku": {
+ "name": "DSv3-Type1",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "tags": {
+ "key2574": "aaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "properties": {
+ "platformFaultDomainCount": 2,
+ "platformUpdateDomainCount": 20,
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet",
+ "name": "myAvailabilitySet",
+ "type": "Microsoft.Compute/availabilitySets",
+ "tags": {
+ "key9626": "aaaaaaaaaaaaaaaaaaaa",
+ "key2505": "aa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..49a4a62f46b5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/availabilitySetExamples/AvailabilitySets_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json
new file mode 100644
index 000000000000..9388dd9c91fe
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "capacityReservationGroupName": "myCapacityReservationGroup",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1",
+ "2"
+ ]
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myCapacityReservationGroup",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1",
+ "2"
+ ]
+ }
+ },
+ "200": {
+ "body": {
+ "location": "westus",
+ "tags": {
+ "department": "finance",
+ "owner": "myCompany"
+ },
+ "name": "myCapacityReservationGroup",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup",
+ "zones": [
+ "1",
+ "2"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..fadbaa33b3b5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "a",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..61f5ee302b48
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json
new file mode 100644
index 000000000000..095543fc843c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json
@@ -0,0 +1,80 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "capacityReservationGroupName": "myCapacityReservationGroup",
+ "$expand": "instanceView"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2"
+ }
+ ],
+ "instanceView": {
+ "capacityReservations": [
+ {
+ "name": "myCapacityReservation1",
+ "utilizationInfo": {
+ "currentCapacity": 5,
+ "virtualMachinesAllocated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ }
+ ]
+ },
+ {
+ "name": "myCapacityReservation2",
+ "utilizationInfo": {
+ "currentCapacity": 5,
+ "virtualMachinesAllocated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM4"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "name": "myCapacityReservationGroup",
+ "zones": [
+ "3",
+ "1"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json
new file mode 100644
index 000000000000..302eac826659
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "$expand": "virtualMachines/$ref"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{capacityReservationGroupName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}",
+ "type": "Microsoft.Compute/CapacityReservationGroups",
+ "location": "West US",
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2"
+ }
+ ],
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
+ }
+ ]
+ }
+ },
+ {
+ "name": "{capacityReservationGroupName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}",
+ "type": "Microsoft.Compute/CapacityReservationGroups",
+ "location": "West US",
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation3"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation4"
+ }
+ ],
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json
new file mode 100644
index 000000000000..45816b30ff31
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-11-01",
+ "$expand": "virtualMachines/$ref"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{capacityReservationGroupName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}",
+ "type": "Microsoft.Compute/CapacityReservationGroups",
+ "location": "West US",
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2"
+ }
+ ],
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/virtualMachines/myVM2"
+ }
+ ]
+ }
+ },
+ {
+ "name": "{capacityReservationGroupName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}",
+ "type": "Microsoft.Compute/CapacityReservationGroups",
+ "location": "West US",
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation3"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation4"
+ }
+ ],
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/virtualMachines/myVM3"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..649012b1ec89
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "instanceView": {}
+ },
+ "tags": {
+ "key5355": "aaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "tags": {},
+ "zones": [
+ "1",
+ "2"
+ ],
+ "properties": {
+ "capacityReservations": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "virtualMachinesAssociated": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "instanceView": {
+ "capacityReservations": [
+ {
+ "name": "aaaaaaaaaaaaaaaa",
+ "utilizationInfo": {
+ "virtualMachinesAllocated": [
+ {
+ "id": "aaaa"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup",
+ "name": "myCapacityReservationGroup",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..3e8ea66271fe
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json
new file mode 100644
index 000000000000..4a4de938e42c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ]
+ },
+ "capacityReservationGroupName": "myCapacityReservationGroup",
+ "capacityReservationName": "myCapacityReservation"
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myCapacityReservation",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "provisioningState": "Creating",
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "name": "myCapacityReservation",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "provisioningState": "Creating",
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8cec6c00185e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaaa",
+ "capacityReservationName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..7e3a8229e472
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaa",
+ "capacityReservationName": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Get.json
new file mode 100644
index 000000000000..fbf29e9ae7c6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Get.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "capacityReservationGroupName": "myCapacityReservationGroup",
+ "capacityReservationName": "myCapacityReservation",
+ "$expand": "instanceView"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
+ }
+ ],
+ "provisioningState": "Succeeded",
+ "instanceView": {
+ "utilizationInfo": {
+ "currentCapacity": 5,
+ "virtualMachinesAllocated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ }
+ ]
+ },
+ "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
+ },
+ "location": "westus",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ],
+ "name": "myCapacityReservation"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json
new file mode 100644
index 000000000000..4eded3d45d62
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "capacityReservationGroupName": "myCapacityReservationGroup",
+ "api-version": "2022-11-01",
+ "$expand": "virtualMachines/$ref"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{capacityReservationName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/CapacityReservation/{capacityReservationName}",
+ "type": "Microsoft.Compute/CapacityReservations",
+ "location": "West US",
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2"
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3"
+ }
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ]
+ },
+ {
+ "name": "{capacityReservationName}",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/CapacityReservation/{capacityReservationName}",
+ "type": "Microsoft.Compute/CapacityReservations",
+ "location": "West US",
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
+ "virtualMachinesAssociated": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM4"
+ }
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "Standard_A1_v2",
+ "capacity": 4
+ },
+ "zones": [
+ "1"
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..7cc716d2b139
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaa",
+ "capacityReservationName": "aaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "instanceView": {
+ "utilizationInfo": {},
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "tags": {
+ "key4974": "aaaaaaaaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "Standard_DS1_v2",
+ "capacity": 4,
+ "tier": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "reservationId": "{GUID}",
+ "virtualMachinesAssociated": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "provisioningTime": "2021-06-27T01:02:38.3138469+00:00",
+ "provisioningState": "Creating",
+ "instanceView": {
+ "utilizationInfo": {
+ "virtualMachinesAllocated": [
+ {
+ "id": "aaaa"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation",
+ "name": "myCapacityReservation",
+ "type": "aaaaaaaaaaaaaaa"
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..f0517922e994
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "capacityReservationName": "aaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "sku": {}
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..d9ad9ef03d31
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "origin": "aaaaa",
+ "name": "aaaaaaaaaaaa",
+ "display": {
+ "operation": "aaaaaaaaaaaaaaaaaaaaaa",
+ "resource": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "description": "aaaaaaaaaaaaaaaaaaaaaa",
+ "provider": "aaaaaaaaaaaaaaaaaa"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..2f6a67a067a5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8eab4e54a711
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "location": "4_.",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "unit": "Count",
+ "currentValue": 17,
+ "limit": 19,
+ "name": {
+ "value": "aaaaaaaaaaaaaaaaaa",
+ "localizedValue": "aaaaaaaaaaaaaa"
+ }
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e9853803ce27
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "location": "_--",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "unit": "Count",
+ "currentValue": 17,
+ "limit": 19,
+ "name": {}
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..a79ac3de5cd1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "location": "-e",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Standard_A1_V2",
+ "numberOfCores": 1,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 10240,
+ "memoryInMB": 2048,
+ "maxDataDiskCount": 2
+ },
+ {
+ "name": "Standard_A2_V2",
+ "numberOfCores": 2,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 20480,
+ "memoryInMB": 4096,
+ "maxDataDiskCount": 4
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..212621962a89
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "location": "._..",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
new file mode 100644
index 000000000000..c570a4dead56
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myDedicatedHostGroup",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true
+ },
+ "location": "westus",
+ "tags": {
+ "department": "finance",
+ "owner": "myCompany"
+ },
+ "name": "myDedicatedHostGroup",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "zones": [
+ "1"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
new file mode 100644
index 000000000000..f107c133787f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myDedicatedHostGroup",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "tags": {
+ "department": "finance"
+ },
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true
+ }
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "department": "finance",
+ "owner": "myCompany"
+ },
+ "name": "myDedicatedHostGroup",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "zones": [
+ "1"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json
new file mode 100644
index 000000000000..7a51a75afcec
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "expand": "instanceView"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "hosts": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1"
+ },
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2"
+ }
+ ],
+ "supportAutomaticPlacement": true,
+ "instanceView": {
+ "hosts": [
+ {
+ "name": "myHost1",
+ "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "Standard_A1",
+ "count": 10
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ },
+ {
+ "code": "HealthState/available",
+ "level": "Info",
+ "displayStatus": "Host available"
+ }
+ ]
+ },
+ {
+ "name": "myHost2",
+ "assetId": "f293d4ac-5eea-4be2-b0c0-0fcaa09aebf8",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "Standard_A1",
+ "count": 10
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ },
+ {
+ "code": "HealthState/available",
+ "level": "Info",
+ "displayStatus": "Host available"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "name": "myDedicatedHostGroup",
+ "zones": [
+ "3"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json
new file mode 100644
index 000000000000..dec3c3fe624b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "expand": "instanceView"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "hosts": [
+ {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost"
+ }
+ ],
+ "supportAutomaticPlacement": true,
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true
+ },
+ "instanceView": {
+ "hosts": [
+ {
+ "name": "myHost",
+ "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "Standard_A1",
+ "count": 10
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ },
+ {
+ "code": "HealthState/available",
+ "level": "Info",
+ "displayStatus": "Host available"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "name": "myDedicatedHostGroup",
+ "zones": [
+ "3"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..d23c92c59f55
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MaximumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "a",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..c84bbae8eb0b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Delete_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MaximumSet_Gen.json
new file mode 100644
index 000000000000..b2b58deb8881
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MaximumSet_Gen.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "tags": {},
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "hosts": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "instanceView": {
+ "hosts": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "assetId": "aaaa",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "name": "myDedicatedHostGroup",
+ "type": "aaaa"
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MinimumSet_Gen.json
new file mode 100644
index 000000000000..d9f2a47060c1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListByResourceGroup_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MaximumSet_Gen.json
new file mode 100644
index 000000000000..ce38cc4ad25f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MaximumSet_Gen.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "tags": {},
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "hosts": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "instanceView": {
+ "hosts": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "assetId": "aaaa",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "name": "myDedicatedHostGroup",
+ "type": "aaaa"
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MinimumSet_Gen.json
new file mode 100644
index 000000000000..3f2cfff0167b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_ListBySubscription_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..83b9aa1b5a64
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MaximumSet_Gen.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaa",
+ "parameters": {
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "instanceView": {
+ "hosts": [
+ {
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "zones": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ],
+ "tags": {
+ "key9921": "aaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "tags": {},
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "platformFaultDomainCount": 3,
+ "supportAutomaticPlacement": true,
+ "hosts": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "instanceView": {
+ "hosts": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "assetId": "aaaa",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
+ "name": "myDedicatedHostGroup",
+ "type": "aaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..c61af21f2e15
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHostGroups_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
new file mode 100644
index 000000000000..5be1107ad707
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "department": "HR"
+ },
+ "properties": {
+ "platformFaultDomain": 1
+ },
+ "sku": {
+ "name": "DSv3-Type1"
+ }
+ },
+ "hostGroupName": "myDedicatedHostGroup",
+ "hostName": "myDedicatedHost"
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myDedicatedHost",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "DSv3-Type1"
+ },
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": true,
+ "hostId": "{GUID}"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": false,
+ "licenseType": "Windows_Server_Hybrid",
+ "hostId": "{GUID}"
+ },
+ "location": "westus",
+ "tags": {
+ "department": "HR"
+ },
+ "name": "myDedicatedHost",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
+ "sku": {
+ "name": "DSv3-Type1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Get.json
new file mode 100644
index 000000000000..41e52a9a746a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Get.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "hostName": "myHost"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": true,
+ "hostId": "{GUID}",
+ "provisioningTime": "2019-06-27T01:02:38.3138469+00:00",
+ "virtualMachines": [
+ {
+ "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1"
+ }
+ ],
+ "provisioningState": "Succeeded",
+ "instanceView": {
+ "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "Standard_A1",
+ "count": 10
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded"
+ },
+ {
+ "code": "HealthState/available",
+ "level": "Info",
+ "displayStatus": "Host available"
+ }
+ ]
+ },
+ "timeCreated": "2019-06-27T01:02:38.3138469+00:00"
+ },
+ "location": "westus",
+ "tags": {
+ "department": "HR"
+ },
+ "sku": {
+ "name": "DSv3-Type1"
+ },
+ "name": "myHost"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json
new file mode 100644
index 000000000000..690290fee0eb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "hostGroupName": "myDedicatedHostGroup",
+ "hostName": "myHost"
+ },
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..5eaae0ca60b3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaaaa",
+ "hostName": "aaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..2acedbd195b8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Delete_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaaaaaaaaaaaaa",
+ "hostName": "aaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MaximumSet_Gen.json
new file mode 100644
index 000000000000..950037a0c1d6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MaximumSet_Gen.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": true,
+ "hostId": "{GUID}",
+ "virtualMachines": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "licenseType": "Windows_Server_Hybrid",
+ "provisioningTime": "2021-11-30T12:58:26.526Z",
+ "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceView": {
+ "assetId": "aaaaaaaaaaaaaaaa",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "sku": {
+ "name": "DSv3-Type1",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
+ "name": "myDedicatedHost",
+ "type": "aaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "nextLink": "aaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MinimumSet_Gen.json
new file mode 100644
index 000000000000..ce31768edf16
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_ListByHostGroup_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "sku": {}
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..fd9c0f0381ac
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MaximumSet_Gen.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aaaaaaaaa",
+ "hostName": "aaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": true,
+ "licenseType": "Windows_Server_Hybrid",
+ "instanceView": {
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key8813": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "platformFaultDomain": 1,
+ "autoReplaceOnFailure": true,
+ "hostId": "{GUID}",
+ "virtualMachines": [
+ {
+ "id": "aaaa"
+ }
+ ],
+ "licenseType": "Windows_Server_Hybrid",
+ "provisioningTime": "2021-11-30T12:58:26.526Z",
+ "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceView": {
+ "assetId": "aaaaaaaaaaaaaaaa",
+ "availableCapacity": {
+ "allocatableVMs": [
+ {
+ "vmSize": "aaaaaaaaaaaaaaaaaaaa",
+ "count": 26
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "sku": {
+ "name": "DSv3-Type1",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
+ "name": "myDedicatedHost",
+ "type": "aaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..080db5e22014
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/dedicatedHostExamples/DedicatedHosts_Update_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "hostGroupName": "aa",
+ "hostName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "sku": {}
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlob.json
new file mode 100644
index 000000000000..c2e23399a222
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlob.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "osState": "Generalized"
+ },
+ "zoneResilient": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json
new file mode 100644
index 000000000000..7b93e8d5fae4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDisk.json
new file mode 100644
index 000000000000..8de24c69d970
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDisk.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized"
+ },
+ "zoneResilient": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json
new file mode 100644
index 000000000000..96a9f8ed1b04
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshot.json
new file mode 100644
index 000000000000..b3a98eaac310
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshot.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized"
+ },
+ "zoneResilient": false
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json
new file mode 100644
index 000000000000..1ff2a4971d4a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": []
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAVM.json
new file mode 100644
index 000000000000..009141a4d67d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_CreateFromAVM.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "sourceVirtualMachine": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "sourceVirtualMachine": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "managedDisk": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022"
+ },
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "sourceVirtualMachine": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "managedDisk": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022"
+ },
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json
new file mode 100644
index 000000000000..14add9dd1bb9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json
@@ -0,0 +1,81 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "osState": "Generalized"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd"
+ }
+ ],
+ "zoneResilient": false
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd"
+ }
+ ],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "osState": "Generalized",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd"
+ }
+ ],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json
new file mode 100644
index 000000000000..3d85ab1c9a53
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ }
+ }
+ ],
+ "zoneResilient": false
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ }
+ }
+ ],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "managedDisk": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ }
+ }
+ ],
+ "zoneResilient": false
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json
new file mode 100644
index 000000000000..8cf8c1fefc35
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ }
+ }
+ ],
+ "zoneResilient": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ }
+ }
+ ],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ },
+ "201": {
+ "body": {
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Linux",
+ "snapshot": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "osState": "Generalized",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ }
+ }
+ ],
+ "zoneResilient": true
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/images",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Get.json
new file mode 100644
index 000000000000..9ad51bc5f98f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Get.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage",
+ "type": "Microsoft.Compute/images",
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
+ },
+ "osState": "Generalized",
+ "storageAccountType": "Standard_LRS",
+ "diskSizeGB": 20
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ },
+ "storageAccountType": "Standard_LRS"
+ }
+ ],
+ "zoneResilient": true
+ },
+ "provisioningState": "created"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListByResourceGroup.json
new file mode 100644
index 000000000000..ca5f2d5bc3b1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListByResourceGroup.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage",
+ "type": "Microsoft.Compute/images",
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
+ },
+ "osState": "Generalized",
+ "storageAccountType": "Standard_LRS"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ },
+ "storageAccountType": "Standard_LRS"
+ }
+ ]
+ },
+ "provisioningState": "created"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListBySubscription.json
new file mode 100644
index 000000000000..ccc43a4fce14
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_ListBySubscription.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage",
+ "type": "Microsoft.Compute/images",
+ "location": "West US",
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
+ },
+ "osState": "Generalized",
+ "storageAccountType": "Standard_LRS"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ },
+ "storageAccountType": "Standard_LRS"
+ }
+ ]
+ },
+ "provisioningState": "created"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Update.json
new file mode 100644
index 000000000000..9c98db1370c2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Image_Update.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "imageName": "myImage",
+ "parameters": {
+ "properties": {
+ "sourceVirtualMachine": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ },
+ "hyperVGeneration": "V1"
+ },
+ "tags": {
+ "department": "HR"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage",
+ "type": "Microsoft.Compute/images",
+ "location": "West US",
+ "tags": {
+ "department": "HR"
+ },
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
+ },
+ "osState": "Generalized",
+ "storageAccountType": "Standard_LRS",
+ "diskSizeGB": 20
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ },
+ "storageAccountType": "Standard_LRS"
+ }
+ ],
+ "zoneResilient": true
+ },
+ "provisioningState": "created"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage",
+ "name": "myImage",
+ "type": "Microsoft.Compute/images",
+ "location": "West US",
+ "tags": {
+ "department": "HR"
+ },
+ "properties": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1"
+ },
+ "osState": "Generalized",
+ "storageAccountType": "Standard_LRS",
+ "diskSizeGB": 20
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd",
+ "snapshot": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2"
+ },
+ "managedDisk": {
+ "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2"
+ },
+ "storageAccountType": "Standard_LRS"
+ }
+ ],
+ "zoneResilient": true
+ },
+ "provisioningState": "created"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..7596a0982ade
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "imageName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..07e96551324d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "imageName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
new file mode 100644
index 000000000000..34b12d6af893
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "intervalLength": "FiveMins",
+ "blobContainerSasUri": "https://somesasuri",
+ "fromTime": "2018-01-21T01:54:06.862601Z",
+ "toTime": "2018-01-23T01:54:06.862601Z",
+ "groupByResourceName": true
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json
new file mode 100644
index 000000000000..cc163e811409
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "westus",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "blobContainerSasUri": "https://somesasuri",
+ "fromTime": "2018-01-21T01:54:06.862601Z",
+ "toTime": "2018-01-23T01:54:06.862601Z",
+ "groupByOperationName": true,
+ "groupByResourceName": false,
+ "groupByClientApplicationId": false,
+ "groupByUserAgent": false
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv"
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json
new file mode 100644
index 000000000000..060eda626535
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "proximityPlacementGroupName": "myProximityPlacementGroup",
+ "parameters": {
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ }
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ }
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json
new file mode 100644
index 000000000000..d87695a4b90e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "proximityPlacementGroupName": "myProximityPlacementGroup",
+ "parameters": {}
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json
new file mode 100644
index 000000000000..bf79b943d0eb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "proximityPlacementGroupName": "myProximityPlacementGroup",
+ "parameters": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ },
+ "virtualMachines": [
+ {
+ "id": "string"
+ }
+ ],
+ "virtualMachineScaleSets": [
+ {
+ "id": "string"
+ }
+ ],
+ "availabilitySets": [
+ {
+ "id": "string"
+ }
+ ]
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json
new file mode 100644
index 000000000000..b5b3d0889dd7
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "parameters": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ },
+ "virtualMachines": [
+ {
+ "id": "string"
+ }
+ ],
+ "virtualMachineScaleSets": [
+ {
+ "id": "string"
+ }
+ ],
+ "availabilitySets": [
+ {
+ "id": "string"
+ }
+ ]
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ ],
+ "nextLink": "string"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json
new file mode 100644
index 000000000000..01292bc74904
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-11-01",
+ "parameters": {}
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard",
+ "intent": {
+ "vmSizes": [
+ "Basic_A0",
+ "Basic_A2"
+ ]
+ },
+ "virtualMachines": [
+ {
+ "id": "string"
+ }
+ ],
+ "virtualMachineScaleSets": [
+ {
+ "id": "string"
+ }
+ ],
+ "availabilitySets": [
+ {
+ "id": "string"
+ }
+ ]
+ },
+ "location": "westus",
+ "zones": [
+ "1"
+ ],
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ ],
+ "nextLink": "string"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json
new file mode 100644
index 000000000000..053ea6a85d13
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "proximityPlacementGroupName": "myProximityPlacementGroup",
+ "parameters": {
+ "tags": {
+ "additionalProp1": "string"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myProximityPlacementGroup",
+ "properties": {
+ "proximityPlacementGroupType": "Standard"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/proximityPlacementGroups",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json
new file mode 100644
index 000000000000..83d5ac3a43a5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "myRpc",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "norwayeast",
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ }
+ },
+ "tags": {
+ "myTag1": "tagValue1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRpc",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "norwayeast",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myRpc",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "norwayeast",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json
new file mode 100644
index 000000000000..ba8d124904e3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "myRpc",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "norwayeast",
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName"
+ }
+ },
+ "tags": {
+ "myTag1": "tagValue1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRpc",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "norwayeast",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myRpc",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "norwayeast",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get.json
new file mode 100644
index 000000000000..34b7e0faf867
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "myRpc",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRpc",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json
new file mode 100644
index 000000000000..66729eb855de
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json
@@ -0,0 +1,97 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "rpcName",
+ "api-version": "2022-11-01",
+ "expand": "restorePoints"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "rpcName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "eastus"
+ },
+ "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
+ "provisioningState": "Succeeded",
+ "restorePoints": [
+ {
+ "name": "restorePointName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName",
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
+ }
+ ],
+ "sourceMetadata": {
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "testingexcludedisk_DataDisk_1",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "location": "westus"
+ },
+ "provisioningState": "Succeeded",
+ "consistencyMode": "ApplicationConsistent",
+ "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json
new file mode 100644
index 000000000000..a62b3c53032e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "restorePointCollection1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1",
+ "location": "westus"
+ },
+ "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "name": "restorePointCollection2",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2",
+ "location": "westus"
+ },
+ "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4",
+ "provisioningState": "Deleting"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json
new file mode 100644
index 000000000000..753fa5ac0c2f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "restorePointCollection1",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup1/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Test",
+ "location": "westus"
+ },
+ "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "name": "restorePointCollection2",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup2/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2",
+ "type": "Microsoft.Compute/restorePointCollections",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Prod",
+ "location": "westus"
+ },
+ "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4",
+ "provisioningState": "Deleting"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..887430825cae
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e622db9425fc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Delete_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..98a6259ead69
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MaximumSet_Gen.json
@@ -0,0 +1,193 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM"
+ }
+ },
+ "tags": {
+ "key8536": "aaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "norwayeast",
+ "properties": {
+ "source": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "eastus"
+ },
+ "provisioningState": "Successful",
+ "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c",
+ "restorePoints": [
+ {
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ ],
+ "sourceMetadata": {
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 9,
+ "vCPUsPerCore": 12
+ }
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
+ "caching": "ReadWrite",
+ "diskSizeGB": 3,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "testingexcludedisk_DataDisk_1",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ },
+ "diskSizeGB": 24
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "licenseType": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "location": "westus"
+ },
+ "provisioningState": "aaaaaaaaaaaaaaaaa",
+ "consistencyMode": "CrashConsistent",
+ "timeCreated": "2021-11-30T12:58:26.593Z"
+ },
+ "id": "aaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "tags": {},
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc",
+ "name": "myRpc",
+ "type": "Microsoft.Compute/restorePointCollections"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b1686e57fb17
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePointCollections_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "norwayeast"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json
new file mode 100644
index 000000000000..1e5f6a181fb9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "rpcName",
+ "restorePointName": "rpName",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "properties": {
+ "sourceRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "rpName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
+ "properties": {
+ "sourceRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
+ },
+ "sourceMetadata": {
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "name": "osDisk123",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "dataDisk123",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "location": "westus",
+ "userData": "c2FtcGxlIHVzZXJEYXRh"
+ },
+ "provisioningState": "Creating",
+ "consistencyMode": "ApplicationConsistent",
+ "timeCreated": "2021-10-25T23:54:29.2796325+00:00"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Create.json
new file mode 100644
index 000000000000..a7dafa2849ed
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Create.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "rpcName",
+ "restorePointName": "rpName",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "rpName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ }
+ ],
+ "sourceMetadata": {
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "name": "osDisk123",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "dataDisk123",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "location": "westus",
+ "userData": "c2FtcGxlIHVzZXJEYXRh"
+ },
+ "provisioningState": "Succeeded",
+ "consistencyMode": "ApplicationConsistent",
+ "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get.json
new file mode 100644
index 000000000000..19dc903f6929
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get.json
@@ -0,0 +1,78 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "rpcName",
+ "restorePointName": "rpName",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "rpName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
+ }
+ ],
+ "sourceMetadata": {
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "testingexcludedisk_DataDisk_1",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "location": "westus"
+ },
+ "provisioningState": "Succeeded",
+ "consistencyMode": "ApplicationConsistent",
+ "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json
new file mode 100644
index 000000000000..6b3fb357deea
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json
@@ -0,0 +1,112 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "restorePointCollectionName": "rpcName",
+ "restorePointName": "rpName",
+ "api-version": "2022-11-01",
+ "expand": "instanceView"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "rpName",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
+ "properties": {
+ "excludeDisks": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f"
+ }
+ ],
+ "sourceMetadata": {
+ "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
+ "hardwareProfile": {
+ "vmSize": "Standard_B1s"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ }
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "testingexcludedisk_DataDisk_1",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1"
+ },
+ "diskRestorePoint": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "computerName",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "location": "westus"
+ },
+ "provisioningState": "Succeeded",
+ "consistencyMode": "ApplicationConsistent",
+ "timeCreated": "2021-01-27T20:35:05.8401519+00:00",
+ "instanceView": {
+ "diskRestorePoints": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57",
+ "replicationStatus": {
+ "status": {
+ "code": "ReplicationState/succeeded",
+ "level": "Info",
+ "displayStatus": "Succeeded"
+ },
+ "completionPercent": 100
+ }
+ },
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5",
+ "replicationStatus": {
+ "status": {
+ "code": "ReplicationState/succeeded",
+ "level": "Info",
+ "displayStatus": "Succeeded"
+ },
+ "completionPercent": 100
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "ReplicationState/succeeded",
+ "level": "Info",
+ "displayStatus": "Succeeded"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..11eee0af2c17
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "restorePointName": "a",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..80ed781837bd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/restorePointExamples/RestorePoints_Delete_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "rgcompute",
+ "restorePointCollectionName": "aaaaaaaaaaaaaaaaa",
+ "restorePointName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_Get.json
new file mode 100644
index 000000000000..ca1b0ba4fe85
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_Get.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e",
+ "location": "SoutheastAsia",
+ "commandId": "RunPowerShellScript",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "script": [
+ "param(",
+ " [string]$arg1,",
+ " [string]$arg2",
+ ")",
+ "Write-Host This is a sample script with parameters $arg1 $arg2"
+ ],
+ "parameters": [
+ {
+ "name": "arg1",
+ "type": "string",
+ "defaultValue": "value1"
+ },
+ {
+ "name": "arg2",
+ "type": "string",
+ "defaultValue": "value2"
+ }
+ ],
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "RunPowerShellScript",
+ "osType": "Windows",
+ "label": "Executes a PowerShell script",
+ "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_List.json
new file mode 100644
index 000000000000..a36604cbae31
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/RunCommand_List.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "location": "SoutheastAsia",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "EnableRemotePS",
+ "osType": "Windows",
+ "label": "Enable remote PowerShell",
+ "description": "Configure the machine to enable remote PowerShell."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "IPConfig",
+ "osType": "Windows",
+ "label": "List IP configuration",
+ "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "RunPowerShellScript",
+ "osType": "Windows",
+ "label": "Executes a PowerShell script",
+ "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "RunShellScript",
+ "osType": "Linux",
+ "label": "Executes a Linux shell script",
+ "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "ifconfig",
+ "osType": "Linux",
+ "label": "List network configuration",
+ "description": "Get the configuration of all network interfaces."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "EnableAdminAccount",
+ "osType": "Windows",
+ "label": "Enable administrator account",
+ "description": "Checks if the local Administrator account is disabled, and if so enables it."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "ResetAccountPassword",
+ "osType": "Windows",
+ "label": "Reset built-in Administrator account password",
+ "description": "Reset built-in Administrator account password."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "RDPSettings",
+ "osType": "Windows",
+ "label": "Verify RDP Listener Settings",
+ "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "SetRDPPort",
+ "osType": "Windows",
+ "label": "Set Remote Desktop port",
+ "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port."
+ },
+ {
+ "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json",
+ "id": "ResetRDPCert",
+ "osType": "Windows",
+ "label": "Restore RDP Authentication mode to defaults",
+ "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate."
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand.json
new file mode 100644
index 000000000000..1f963b86be21
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e",
+ "resourceGroupName": "crptestar98131",
+ "vmName": "vm3036",
+ "$top": 1,
+ "api-version": "2022-11-01",
+ "monitor": "true",
+ "parameters": {
+ "commandId": "RunPowerShellScript"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "code": "ComponentStatus/StdOut/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": "This is a sample script with parameters value1 value2"
+ },
+ {
+ "code": "ComponentStatus/StdErr/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": ""
+ }
+ ]
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json
new file mode 100644
index 000000000000..66f086fdab93
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01",
+ "runCommand": {
+ "location": "West US",
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "runAsPassword": "",
+ "timeoutInSeconds": 3600
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachines/runCommands",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachines/runCommands",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json
new file mode 100644
index 000000000000..dc947ceb7139
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json
new file mode 100644
index 000000000000..08fa6d836d2b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachines/runCommands",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
new file mode 100644
index 000000000000..00b3c8db7541
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachines/runCommands",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 0,
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json
new file mode 100644
index 000000000000..1538291ee770
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01",
+ "runCommand": {
+ "properties": {
+ "source": {
+ "script": "Write-Host Script Source Updated!"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachines/runCommands",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Script Source Updated!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json
new file mode 100644
index 000000000000..9c65dd546013
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "instanceId": "0",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "commandId": "RunPowerShellScript",
+ "script": [
+ "Write-Host Hello World!"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "code": "ComponentStatus/StdOut/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": "Hello World!"
+ },
+ {
+ "code": "ComponentStatus/StdErr/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": ""
+ }
+ ]
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
new file mode 100644
index 000000000000..077b7d74442e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01",
+ "runCommand": {
+ "location": "West US",
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "runAsPassword": "",
+ "timeoutInSeconds": 3600
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "location": "westus",
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myRunCommand",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "location": "westus",
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json
new file mode 100644
index 000000000000..5a9c9e5dbb74
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json
new file mode 100644
index 000000000000..8174697d8940
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json
new file mode 100644
index 000000000000..1bb32e25f964
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myRunCommand",
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
+ "properties": {
+ "source": {
+ "script": "Write-Host Hello World!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 0,
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json
new file mode 100644
index 000000000000..8e5dea87a895
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "runCommandName": "myRunCommand",
+ "api-version": "2022-11-01",
+ "runCommand": {
+ "properties": {
+ "source": {
+ "script": "Write-Host Script Source Updated!"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myRunCommand",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand",
+ "location": "westus",
+ "tags": {
+ "tag1": "value1",
+ "tag2": "value2"
+ },
+ "properties": {
+ "source": {
+ "script": "Write-Host Script Source Updated!"
+ },
+ "parameters": [
+ {
+ "name": "param1",
+ "value": "value1"
+ },
+ {
+ "name": "param2",
+ "value": "value2"
+ }
+ ],
+ "asyncExecution": false,
+ "runAsUser": "user1",
+ "timeoutInSeconds": 3600,
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json
new file mode 100644
index 000000000000..ab38d6de896a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "sshPublicKeyName": "mySshPublicKeyName",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "mySshPublicKeyName",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "mySshPublicKeyName",
+ "location": "westus",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json
new file mode 100644
index 000000000000..e68e022428b5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "sshPublicKeyName": "mySshPublicKeyName"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "mySshPublicKeyName",
+ "location": "westus",
+ "tags": {
+ "{tagName}": "{tagValue}"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..99e18fd70aea
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MaximumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "sshPublicKeyName": "aaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..4e7c36b0bc58
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Delete_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "sshPublicKeyName": "aaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_GenerateKeyPair.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_GenerateKeyPair.json
new file mode 100644
index 000000000000..174975f2b4a1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_GenerateKeyPair.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "sshPublicKeyName": "mySshPublicKeyName"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "privateKey": "{ssh private key}",
+ "publicKey": "{ssh-rsa public key}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MaximumSet_Gen.json
new file mode 100644
index 000000000000..e7672d4c00bb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MaximumSet_Gen.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName",
+ "name": "mySshPublicKeyName",
+ "type": "aaaa",
+ "tags": {
+ "key6396": "aaaaaaaaaaaaa",
+ "key8839": "aaa"
+ }
+ }
+ ],
+ "nextLink": "aaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MinimumSet_Gen.json
new file mode 100644
index 000000000000..d9f2a47060c1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MaximumSet_Gen.json
new file mode 100644
index 000000000000..43057ff1d21a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MaximumSet_Gen.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName",
+ "name": "mySshPublicKeyName",
+ "type": "aaaa",
+ "tags": {
+ "key6396": "aaaaaaaaaaaaa",
+ "key8839": "aaa"
+ }
+ }
+ ],
+ "nextLink": "aaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MinimumSet_Gen.json
new file mode 100644
index 000000000000..3f2cfff0167b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8fa6510a3899
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MaximumSet_Gen.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "sshPublicKeyName": "aaaaaaaaaaaa",
+ "parameters": {
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ },
+ "tags": {
+ "key2854": "a"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus",
+ "properties": {
+ "publicKey": "{ssh-rsa public key}"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName",
+ "name": "mySshPublicKeyName",
+ "type": "aaaa",
+ "tags": {
+ "key6396": "aaaaaaaaaaaaa",
+ "key8839": "aaa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..a96ec561e06d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/sshPublicKeyExamples/SshPublicKeys_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "sshPublicKeyName": "aaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MaximumSet_Gen.json
new file mode 100644
index 000000000000..c883f254488d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MaximumSet_Gen.json
@@ -0,0 +1,146 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmExtensionName": "aaaaaaaaaaaaa",
+ "extensionParameters": {
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {},
+ "forceUpdateTag": "a",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key9183": "aa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {},
+ "forceUpdateTag": "a",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key9183": "aa"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {},
+ "forceUpdateTag": "a",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key9183": "aa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MinimumSet_Gen.json
new file mode 100644
index 000000000000..4a7c04a91c4f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MinimumSet_Gen.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaa",
+ "vmExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionParameters": {
+ "location": "westus"
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..ae83eb008f3b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaa",
+ "vmExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b3e8f179310d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmExtensionName": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..dfc754d034dc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MaximumSet_Gen.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmExtensionName": "aaaaaaa",
+ "$expand": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {},
+ "forceUpdateTag": "a",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key9183": "aa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b6d2edeb2980
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Get_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "a",
+ "vmExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..097e715308f3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MaximumSet_Gen.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaa",
+ "$expand": "aaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {},
+ "forceUpdateTag": "a",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ },
+ "tags": {
+ "key9183": "aa"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..bf59a0a1871e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_List_MinimumSet_Gen.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Update.json
new file mode 100644
index 000000000000..9d021173854f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachineExtensions_Update.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "vmExtensionName": "myVMExtension",
+ "api-version": "2022-11-01",
+ "extensionParameters": {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ },
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension",
+ "location": "westus",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "suppressFailures": true,
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ },
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json
new file mode 100644
index 000000000000..da35a4d82b1e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroupName",
+ "vmName": "myVMName",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
+ "rebootPending": true,
+ "criticalAndSecurityPatchCount": 1,
+ "otherPatchCount": 2,
+ "startDateTime": "2020-04-24T21:02:04.2556154Z",
+ "availablePatches": [
+ {
+ "patchId": "35428702-5784-4ba4-a6e0-5222258b5411",
+ "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)",
+ "version": "",
+ "kbId": "2267602",
+ "classifications": [
+ "Definition Updates"
+ ],
+ "rebootBehavior": "NeverReboots",
+ "activityId": "68f8b292-dfc2-4646-9781-33cc88631968",
+ "publishedDate": "2018-11-07T00:00:00Z",
+ "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z",
+ "assessmentState": "Available"
+ },
+ {
+ "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d",
+ "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)",
+ "version": "",
+ "kbId": "890830",
+ "classifications": [
+ "Update Rollups"
+ ],
+ "rebootBehavior": "CanRequestReboot",
+ "activityId": "68f8b292-dfc2-4646-9781-33cc88631968",
+ "publishedDate": "2018-11-07T00:00:00Z",
+ "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z",
+ "assessmentState": "Available"
+ }
+ ],
+ "error": null
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_CreateWithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_CreateWithVMSizeProperties.json
new file mode 100644
index 000000000000..f08c7348a301
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_CreateWithVMSizeProperties.json
@@ -0,0 +1,184 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2021-03-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "userData": "U29tZSBDdXN0b20gRGF0YQ=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "provisioningState": "Updating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json
new file mode 100644
index 000000000000..e168031f061c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json
@@ -0,0 +1,145 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "{vm-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "osDisk": {
+ "name": "myVMosdisk",
+ "image": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "osType": "Windows",
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
+ }
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "osDisk": {
+ "name": "myVMosdisk",
+ "image": {
+ "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Windows",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "osDisk": {
+ "name": "myVMosdisk",
+ "image": {
+ "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Windows",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json
new file mode 100644
index 000000000000..30efd888548a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json
@@ -0,0 +1,144 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json
new file mode 100644
index 000000000000..124e74e55dda
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json
@@ -0,0 +1,144 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json
new file mode 100644
index 000000000000..2219bcb89fba
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json
@@ -0,0 +1,144 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json
new file mode 100644
index 000000000000..60ef8e184fec
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json
@@ -0,0 +1,144 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json
new file mode 100644
index 000000000000..c459156a021c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json
@@ -0,0 +1,123 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": []
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json
new file mode 100644
index 000000000000..9a5718586a3c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json
@@ -0,0 +1,165 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{existing-flex-vmss-name-with-platformFaultDomainCount-greater-than-1}"
+ },
+ "platformFaultDomain": 1
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss"
+ },
+ "platformFaultDomain": 1,
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss"
+ },
+ "platformFaultDomain": 1,
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json
new file mode 100644
index 000000000000..eb87a10da3cc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json
@@ -0,0 +1,162 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json
new file mode 100644
index 000000000000..73f6f09703c1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json
@@ -0,0 +1,175 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json
new file mode 100644
index 000000000000..21b4e701d11f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json
@@ -0,0 +1,163 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json
new file mode 100644
index 000000000000..866789cbd939
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json
@@ -0,0 +1,163 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json
new file mode 100644
index 000000000000..95370a4eb397
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json
new file mode 100644
index 000000000000..819f671c3790
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json
@@ -0,0 +1,213 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "{vm-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0,
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd"
+ }
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1,
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd"
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "name": "dataDisk0",
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "caching": "None",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd"
+ },
+ "lun": 0
+ },
+ {
+ "name": "dataDisk1",
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "caching": "None",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd"
+ },
+ "lun": 1
+ }
+ ]
+ },
+ "vmId": "5230a749-2f68-4830-900b-702182d32e63",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "caching": "ReadWrite"
+ },
+ "dataDisks": [
+ {
+ "name": "dataDisk0",
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "caching": "None",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd"
+ },
+ "lun": 0
+ },
+ {
+ "name": "dataDisk1",
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "caching": "None",
+ "vhd": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd"
+ },
+ "lun": 1
+ }
+ ]
+ },
+ "vmId": "5230a749-2f68-4830-900b-702182d32e63",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json
new file mode 100644
index 000000000000..61c68fd22377
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json
@@ -0,0 +1,178 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json
new file mode 100644
index 000000000000..ab51fb62357e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false,
+ "patchSettings": {
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json
new file mode 100644
index 000000000000..7b22c86f48ad
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByOS"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByOS"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByOS"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json
new file mode 100644
index 000000000000..13f771ec3b01
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json
@@ -0,0 +1,169 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "enableHotpatching": true
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "enableHotpatching": true
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "enableHotpatching": true
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json
new file mode 100644
index 000000000000..d83e42666d59
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "Manual"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "Manual"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false,
+ "patchSettings": {
+ "patchMode": "Manual"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json
new file mode 100644
index 000000000000..c722e8351505
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json
@@ -0,0 +1,169 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "assessmentMode": "AutomaticByPlatform"
+ }
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json
new file mode 100644
index 000000000000..b6b1c566a8a0
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json
@@ -0,0 +1,177 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json
new file mode 100644
index 000000000000..2c9e69a67867
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json
@@ -0,0 +1,180 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json
new file mode 100644
index 000000000000..c28a96d2008e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json
@@ -0,0 +1,180 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json
new file mode 100644
index 000000000000..2c38c5619610
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json
@@ -0,0 +1,168 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json
new file mode 100644
index 000000000000..f430a56bb36e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json
@@ -0,0 +1,208 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "{image_sku}",
+ "publisher": "{image_publisher}",
+ "version": "latest",
+ "offer": "{image_offer}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config",
+ "treatFailureAsDeploymentFailure": false,
+ "enableAutomaticUpgrade": false
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json
new file mode 100644
index 000000000000..22c4a3ec5d25
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json
@@ -0,0 +1,171 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json
new file mode 100644
index 000000000000..a753e95e8532
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json
@@ -0,0 +1,183 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json
new file mode 100644
index 000000000000..929b1c4ad244
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json
@@ -0,0 +1,175 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ },
+ "diskControllerType": "NVMe"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "userData": "U29tZSBDdXN0b20gRGF0YQ=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [],
+ "diskControllerType": "NVMe"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3"
+ },
+ "provisioningState": "Updating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [],
+ "diskControllerType": "NVMe"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D4_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json
new file mode 100644
index 000000000000..e7d57180f661
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json
@@ -0,0 +1,229 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Attach",
+ "lun": 1
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskencryptionset-name}"
+ }
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Attach",
+ "lun": 1
+ }
+ ]
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "name": "myVMosdisk",
+ "diskSizeGB": 30,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "osType": "Linux"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}",
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Attach",
+ "lun": 1
+ }
+ ]
+ },
+ "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json
new file mode 100644
index 000000000000..3c2de722d428
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json
@@ -0,0 +1,205 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023
+ }
+ ]
+ },
+ "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023,
+ "toBeDetached": false
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json
new file mode 100644
index 000000000000..1e1d5448dfab
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json
@@ -0,0 +1,177 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json
new file mode 100644
index 000000000000..e5822b3e7087
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json
@@ -0,0 +1,174 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "extensionsTimeBudget": "PT30M"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "extensionsTimeBudget": "PT30M",
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "extensionsTimeBudget": "PT30M",
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json
new file mode 100644
index 000000000000..c90beca8b5e0
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json
@@ -0,0 +1,180 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "{vm-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "eastus2euap",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "additionalCapabilities": {
+ "hibernationEnabled": true
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2019-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "vmOSdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "{vm-name}",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "{vm-name}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2019-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "vmOSdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "additionalCapabilities": {
+ "hibernationEnabled": true
+ },
+ "provisioningState": "Updating"
+ },
+ "name": "{vm-name}",
+ "location": "eastus2euap"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "{vm-name}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2019-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "vmOSdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "additionalCapabilities": {
+ "hibernationEnabled": true
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "{vm-name}",
+ "location": "eastus2euap"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json
new file mode 100644
index 000000000000..0d58db51f13e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json
@@ -0,0 +1,168 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json
new file mode 100644
index 000000000000..aa582b393528
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json
@@ -0,0 +1,174 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkApiVersion": "2020-11-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{nic-config-name}",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "ipConfigurations": [
+ {
+ "name": "{ip-config-name}",
+ "properties": {
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "{publicIP-config-name}",
+ "sku": {
+ "name": "Basic",
+ "tier": "Global"
+ },
+ "properties": {
+ "deleteOption": "Detach",
+ "publicIPAllocationMethod": "Static"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json
new file mode 100644
index 000000000000..e2667379ee64
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json
@@ -0,0 +1,153 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json
new file mode 100644
index 000000000000..7c3c573faffa
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json
@@ -0,0 +1,153 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "a149cd25-409f-41af-8088-275f5486bc93",
+ "hardwareProfile": {
+ "vmSize": "Standard_DS1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json
new file mode 100644
index 000000000000..bc83f42fdab6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json
@@ -0,0 +1,201 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json
new file mode 100644
index 000000000000..7dd4b07d66b8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json
@@ -0,0 +1,181 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState"
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState"
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState"
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json
new file mode 100644
index 000000000000..bf66d87bf9ae
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json
@@ -0,0 +1,190 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "DiskWithVMGuestState",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ }
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_DC2as_v5"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json
new file mode 100644
index 000000000000..234592df7461
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json
@@ -0,0 +1,177 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "{image_sku}",
+ "publisher": "{image_publisher}",
+ "version": "latest",
+ "offer": "{image_offer}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "osType": "Linux",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json
new file mode 100644
index 000000000000..e3f15eaf1387
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json
@@ -0,0 +1,174 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ }
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myVM",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage",
+ "name": "myVMosdisk"
+ },
+ "dataDisks": []
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "provisioningState": "Creating"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json
new file mode 100644
index 000000000000..ebfbad41d6e6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json
@@ -0,0 +1,172 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "{vm-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "vmOSdisk",
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "{vm-name}",
+ "adminPassword": "{your-password}"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "{vm-name}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "vmOSdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "{vm-name}",
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "{vm-name}",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "vmOSdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": []
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa",
+ "hardwareProfile": {
+ "vmSize": "Standard_D1_v2"
+ },
+ "provisioningState": "Creating"
+ },
+ "name": "{vm-name}",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json
new file mode 100644
index 000000000000..1f150eedbfdb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "forceDeletion": "true",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json
new file mode 100644
index 000000000000..0b506e65e72d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "myVMName"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get.json
new file mode 100644
index 000000000000..d0102d5a7094
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "$expand": "userData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "West US",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
+ },
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_DS3_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "myOsDisk",
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
+ },
+ "diskSizeGB": 30
+ },
+ "dataDisks": [
+ {
+ "lun": 0,
+ "name": "myDataDisk0",
+ "createOption": "Empty",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
+ },
+ "diskSizeGB": 30
+ },
+ {
+ "lun": 1,
+ "name": "myDataDisk1",
+ "createOption": "Attach",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
+ },
+ "diskSizeGB": 100
+ }
+ ]
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerName": "myVM",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false
+ },
+ "secrets": []
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
+ }
+ },
+ "extensionsTimeBudget": "PT50M",
+ "provisioningState": "Succeeded",
+ "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "west us",
+ "tags": {
+ "displayName": "CustomScriptExtension-DSC"
+ },
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
new file mode 100644
index 000000000000..10bfd1396197
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "West US",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
+ "hostGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_D2s_v3"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "myOsDisk",
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
+ },
+ "diskSizeGB": 30
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "myVM",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false
+ },
+ "secrets": []
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
+ }
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
new file mode 100644
index 000000000000..aef8f43f2a70
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json
@@ -0,0 +1,138 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "myVM"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "platformUpdateDomain": 1,
+ "platformFaultDomain": 1,
+ "computerName": "myVM",
+ "osName": "Windows Server 2016 Datacenter",
+ "osVersion": "Microsoft Windows NT 10.0.14393.0",
+ "vmAgent": {
+ "vmAgentVersion": "2.7.41491.949",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Ready",
+ "message": "GuestAgent is running and accepting new configurations.",
+ "time": "2019-10-14T23:11:22+00:00"
+ }
+ ],
+ "extensionHandlers": [
+ {
+ "type": "Microsoft.Azure.Security.IaaSAntimalware",
+ "typeHandlerVersion": "1.5.5.9",
+ "status": {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Ready"
+ }
+ }
+ ]
+ },
+ "disks": [
+ {
+ "name": "myOsDisk",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2019-10-14T21:29:47.477089+00:00"
+ }
+ ]
+ },
+ {
+ "name": "myDataDisk0",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2019-10-14T21:29:47.461517+00:00"
+ }
+ ]
+ }
+ ],
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp",
+ "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log"
+ },
+ "extensions": [
+ {
+ "name": "IaaSAntiMalware-ext0",
+ "type": "Microsoft.Azure.Security.IaaSAntimalware",
+ "typeHandlerVersion": "1.5.5.9",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": "Microsoft Antimalware enabled"
+ }
+ ]
+ }
+ ],
+ "hyperVGeneration": "V1",
+ "patchStatus": {
+ "availablePatchSummary": {
+ "status": "Succeeded",
+ "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
+ "rebootPending": true,
+ "criticalAndSecurityPatchCount": 1,
+ "otherPatchCount": 2,
+ "startTime": "2020-04-24T21:02:04.2556154Z",
+ "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
+ "error": null
+ },
+ "lastPatchInstallationSummary": {
+ "status": "Succeeded",
+ "installationActivityId": "68f8b292-dfc2-4646-9981-33cc88631968",
+ "maintenanceWindowExceeded": false,
+ "notSelectedPatchCount": 1,
+ "excludedPatchCount": 1,
+ "pendingPatchCount": 1,
+ "installedPatchCount": 1,
+ "failedPatchCount": 1,
+ "startTime": "2020-04-24T21:02:04.2556154Z",
+ "lastModifiedTime": "2020-04-24T21:02:04.2556154Z",
+ "error": null
+ },
+ "configurationStatuses": [
+ {
+ "code": "PatchModeConfigurationState/Ready",
+ "level": "Info",
+ "displayStatus": "Status_PatchModeConfigurationState_Ready",
+ "time": "2020-04-24T21:02:04.2556154Z"
+ },
+ {
+ "code": "AssessmentModeConfigurationState/Pending",
+ "level": "Info",
+ "displayStatus": "Status_AssessmentModeConfigurationState_Pending",
+ "time": "2020-04-24T21:02:04.2556154Z"
+ }
+ ]
+ },
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2019-10-14T21:30:12.8051917+00:00"
+ },
+ {
+ "code": "PowerState/running",
+ "level": "Info",
+ "displayStatus": "VM running"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
new file mode 100644
index 000000000000..ac81b36928ff
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "myVM"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "computerName": "myVM",
+ "osName": "Windows Server 2016 Datacenter",
+ "osVersion": "Microsoft Windows NT 10.0.14393.0",
+ "vmAgent": {
+ "vmAgentVersion": "2.7.41491.949",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Ready",
+ "message": "GuestAgent is running and accepting new configurations.",
+ "time": "2022-11-01T23:11:22+00:00"
+ }
+ ]
+ },
+ "disks": [
+ {
+ "name": "myOsDisk",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2022-11-01T21:29:47.477089+00:00"
+ }
+ ]
+ }
+ ],
+ "hyperVGeneration": "V1",
+ "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "time": "2022-11-01T21:30:12.8051917+00:00"
+ },
+ {
+ "code": "PowerState/running",
+ "level": "Info",
+ "displayStatus": "VM running"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
new file mode 100644
index 000000000000..4e1e1a0b79c2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json
@@ -0,0 +1,136 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "$expand": "userData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "West US",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_DS3_v2",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "myOsDisk",
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
+ },
+ "diskSizeGB": 30
+ },
+ "dataDisks": [
+ {
+ "lun": 0,
+ "name": "myDataDisk0",
+ "createOption": "Empty",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
+ },
+ "diskSizeGB": 30
+ },
+ {
+ "lun": 1,
+ "name": "myDataDisk1",
+ "createOption": "Attach",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
+ },
+ "diskSizeGB": 100
+ }
+ ],
+ "diskControllerType": "NVMe"
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerName": "myVM",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false
+ },
+ "secrets": []
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
+ }
+ },
+ "extensionsTimeBudget": "PT50M",
+ "provisioningState": "Succeeded"
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "west us",
+ "tags": {
+ "displayName": "CustomScriptExtension-DSC"
+ },
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
new file mode 100644
index 000000000000..4a614dc723f9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "expand": "UserData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVM",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "West US",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_DS3_v2",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2016-Datacenter",
+ "version": "latest"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "myOsDisk",
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
+ },
+ "diskSizeGB": 30
+ },
+ "dataDisks": [
+ {
+ "lun": 0,
+ "name": "myDataDisk0",
+ "createOption": "Empty",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
+ },
+ "diskSizeGB": 30
+ },
+ {
+ "lun": 1,
+ "name": "myDataDisk1",
+ "createOption": "Attach",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
+ },
+ "diskSizeGB": 100
+ }
+ ]
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerName": "myVM",
+ "adminUsername": "admin",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": false
+ },
+ "secrets": []
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
+ }
+ },
+ "extensionsTimeBudget": "PT50M",
+ "provisioningState": "Succeeded"
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "west us",
+ "tags": {
+ "displayName": "CustomScriptExtension-DSC"
+ },
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
new file mode 100644
index 000000000000..d4579392113d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroupName",
+ "vmName": "myVMName",
+ "api-version": "2022-11-01",
+ "installPatchesInput": {
+ "maximumDuration": "PT4H",
+ "rebootSetting": "IfRequired",
+ "windowsParameters": {
+ "classificationsToInclude": [
+ "Critical",
+ "Security"
+ ],
+ "maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968",
+ "rebootStatus": "Completed",
+ "maintenanceWindowExceeded": false,
+ "excludedPatchCount": 0,
+ "notSelectedPatchCount": 0,
+ "pendingPatchCount": 2,
+ "installedPatchCount": 3,
+ "failedPatchCount": 0,
+ "startDateTime": "2020-04-24T21:02:04.2556154Z",
+ "patches": [
+ {
+ "patchId": "35428702-5784-4ba4-a6e0-5222258b5411",
+ "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)",
+ "version": "",
+ "kbId": "2267602",
+ "classifications": [
+ "Definition Updates"
+ ],
+ "installationState": "Installed"
+ },
+ {
+ "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d",
+ "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)",
+ "version": "",
+ "kbId": "890830",
+ "classifications": [
+ "Update Rollups"
+ ],
+ "installationState": "Pending"
+ }
+ ],
+ "error": null
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json
new file mode 100644
index 000000000000..9e0d2d05fee7
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "VMName"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
new file mode 100644
index 000000000000..c85a6a5706c6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "myVMName",
+ "parameters": {
+ "tempDisk": true
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
new file mode 100644
index 000000000000..fa0bc630889c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "myVMName",
+ "parameters": {
+ "tempDisk": true,
+ "exactVersion": "aaaaaa",
+ "osProfile": {
+ "adminPassword": "{your-password}",
+ "customData": "{your-custom-data}"
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json
new file mode 100644
index 000000000000..b9c57d876ded
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "VMName",
+ "sasUriExpirationTimeInMinutes": 60
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "consoleScreenshotBlobUri": "https://storageuri/vm.screenshot.bmp?{sasKey}",
+ "serialConsoleLogBlobUri": "https://storageuri/vm.serialconsole.log?{sasKey}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json
new file mode 100644
index 000000000000..691caa7b6826
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ResourceGroup",
+ "api-version": "2022-11-01",
+ "vmName": "VMName"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json
new file mode 100644
index 000000000000..18a1d018d6cd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0,
+ "toBeDetached": true
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023,
+ "toBeDetached": true
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Updating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json
new file mode 100644
index 000000000000..44093a8bfa71
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json
@@ -0,0 +1,137 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVM",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "properties": {
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "name": "myVMosdisk",
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0,
+ "toBeDetached": true,
+ "detachOption": "ForceDetach"
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "computerName": "myVM",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
+ "type": "Microsoft.Compute/virtualMachines",
+ "properties": {
+ "osProfile": {
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "computerName": "myVM",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic",
+ "properties": {
+ "primary": true
+ }
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "myVMosdisk",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ }
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023,
+ "toBeDetached": true,
+ "detachOption": "ForceDetach"
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0",
+ "hardwareProfile": {
+ "vmSize": "Standard_D2_v2"
+ },
+ "provisioningState": "Updating"
+ },
+ "name": "myVM",
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MaximumSet_Gen.json
new file mode 100644
index 000000000000..58b0df848e26
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MaximumSet_Gen.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "vhdPrefix": "aaaaaaaaa",
+ "destinationContainerName": "aaaaaaa",
+ "overwriteVhds": true
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$schema": "aaaaa",
+ "contentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {},
+ "resources": [
+ {}
+ ],
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MinimumSet_Gen.json
new file mode 100644
index 000000000000..cb6272403bfe
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Capture_MinimumSet_Gen.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaa",
+ "parameters": {
+ "vhdPrefix": "aaaaaaaaa",
+ "destinationContainerName": "aaaaaaa",
+ "overwriteVhds": true
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MaximumSet_Gen.json
new file mode 100644
index 000000000000..51a5bb7b049e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MinimumSet_Gen.json
new file mode 100644
index 000000000000..687e9b233ecd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MaximumSet_Gen.json
new file mode 100644
index 000000000000..da73b5a1aa49
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaa",
+ "hibernate": true,
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MinimumSet_Gen.json
new file mode 100644
index 000000000000..98328d568aee
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Deallocate_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MaximumSet_Gen.json
new file mode 100644
index 000000000000..3f70b0985e48
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MaximumSet_Gen.json
@@ -0,0 +1,932 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}",
+ "statusOnly": "aaaaaa",
+ "$filter": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 7,
+ "vCPUsPerCore": 14
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406",
+ "exactVersion": "aaaaaaaaaaaaa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaa",
+ "communityGalleryImageId": "aaaa",
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaaaaaaaaaaaaaaaaaaaaa",
+ "keyData": "aaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "requireGuestProvisionSignal": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2022-05-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "disableTcpStateTracking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 23,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 26
+ },
+ "host": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaaaaaaa",
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "platformFaultDomain": 8,
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "userData": "aaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaa",
+ "order": 4,
+ "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "timeCreated": "2022-01-14T16:43:41.683Z"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {},
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}",
+ "plan": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaa"
+ },
+ "resources": [
+ {
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "platformFaultDomain": 0
+ },
+ "suppressFailures": true,
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaa",
+ "tags": {
+ "key9428": "aaaaaaa"
+ }
+ }
+ ],
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaaa",
+ "tenantId": "aaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key5688": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "clientId": "aaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaa",
+ "type": "EdgeZone"
+ }
+ },
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 7,
+ "vCPUsPerCore": 14
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406",
+ "exactVersion": "aa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaaaaaaaaaaaaaaaaaaaaa",
+ "keyData": "aaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "requireGuestProvisionSignal": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2022-05-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "disableTcpStateTracking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 23,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 26
+ },
+ "host": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "instanceView": {
+ "platformUpdateDomain": 1,
+ "platformFaultDomain": 29,
+ "computerName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "osName": "aaaaaaaaaaa",
+ "osVersion": "aaaaaaaaaaaaaa",
+ "hyperVGeneration": "V1",
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaa",
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
+ "preMaintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
+ "maintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
+ "maintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aa"
+ },
+ "disks": [
+ {
+ "name": "a",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ },
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "serialConsoleLogBlobUri": "aaaaaaaaaaaaaaaaaaa",
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ },
+ "assignedHost": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "patchStatus": {
+ "availablePatchSummary": {
+ "status": "Unknown",
+ "assessmentActivityId": "aaaaaaaaaaaaaaaaaaa",
+ "rebootPending": true,
+ "criticalAndSecurityPatchCount": 22,
+ "otherPatchCount": 25,
+ "startTime": "2022-01-14T16:43:41.682Z",
+ "lastModifiedTime": "2022-01-14T16:43:41.683Z",
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaaaa",
+ "message": "aaaaaaaaaaaaa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaa",
+ "target": "aaaaaaaaa",
+ "message": "aaa"
+ }
+ },
+ "lastPatchInstallationSummary": {
+ "status": "Unknown",
+ "installationActivityId": "aaaaaa",
+ "maintenanceWindowExceeded": true,
+ "notSelectedPatchCount": 20,
+ "excludedPatchCount": 1,
+ "pendingPatchCount": 2,
+ "installedPatchCount": 28,
+ "failedPatchCount": 30,
+ "startTime": "2022-01-14T16:43:41.683Z",
+ "lastModifiedTime": "2022-01-14T16:43:41.683Z",
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaaaa",
+ "message": "aaaaaaaaaaaaa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaa",
+ "target": "aaaaaaaaa",
+ "message": "aaa"
+ }
+ },
+ "configurationStatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ },
+ "licenseType": "aaaaaaaaaaaaaa",
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa",
+ "platformFaultDomain": 11,
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaaaaaaaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaa",
+ "order": 4,
+ "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "timeCreated": "2022-01-14T16:43:41.685Z"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {},
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}",
+ "plan": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaa"
+ },
+ "resources": [
+ {
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "platformFaultDomain": 5
+ },
+ "suppressFailures": true,
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaa",
+ "tags": {
+ "key9428": "aaaaaaa"
+ }
+ }
+ ],
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaaa",
+ "tenantId": "aaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key5688": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "clientId": "aaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaa",
+ "type": "EdgeZone"
+ }
+ }
+ ],
+ "nextLink": "a"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MinimumSet_Gen.json
new file mode 100644
index 000000000000..185d05db5d60
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAll_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus"
+ },
+ {
+ "location": "eastus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAvailableVmSizes.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAvailableVmSizes.json
new file mode 100644
index 000000000000..b913f3d10238
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListAvailableVmSizes.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmName": "myVmName",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Standard_A1_V2",
+ "numberOfCores": 1,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 10240,
+ "memoryInMB": 2048,
+ "maxDataDiskCount": 2
+ },
+ {
+ "name": "Standard_A2_V2",
+ "numberOfCores": 2,
+ "osDiskSizeInMB": 1047552,
+ "resourceDiskSizeInMB": 20480,
+ "memoryInMB": 4096,
+ "maxDataDiskCount": 4
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListBySubscription_ByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListBySubscription_ByLocation.json
new file mode 100644
index 000000000000..b6d4b456e07a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_ListBySubscription_ByLocation.json
@@ -0,0 +1,127 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscriptionId}",
+ "location": "eastus",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}"
+ }
+ ]
+ },
+ "provisioningState": "Succeeded"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {
+ "RG": "rg",
+ "testTag": "1"
+ },
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}"
+ },
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}"
+ }
+ ]
+ },
+ "provisioningState": "Succeeded"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {
+ "RG": "rg",
+ "testTag": "1"
+ },
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..577429e8a75d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MaximumSet_Gen.json
@@ -0,0 +1,930 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "$filter": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 7,
+ "vCPUsPerCore": 14
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406",
+ "exactVersion": "aaaaaaaaaaaaa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaa",
+ "communityGalleryImageId": "aaaa",
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaaaaaaaaaaaaaaaaaaaaa",
+ "keyData": "aaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "requireGuestProvisionSignal": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2022-05-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "disableTcpStateTracking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 23,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 26
+ },
+ "host": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaaaaaaa",
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "platformFaultDomain": 8,
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "userData": "aaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaa",
+ "order": 4,
+ "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "timeCreated": "2022-01-14T16:43:41.683Z"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {},
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}",
+ "plan": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaa"
+ },
+ "resources": [
+ {
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ },
+ "suppressFailures": true,
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaa",
+ "tags": {
+ "key9428": "aaaaaaa"
+ }
+ }
+ ],
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaaa",
+ "tenantId": "aaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key5688": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "clientId": "aaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaa",
+ "type": "EdgeZone"
+ }
+ },
+ {
+ "properties": {
+ "vmId": "{vmId}",
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hardwareProfile": {
+ "vmSize": "Standard_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 7,
+ "vCPUsPerCore": 14
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20170406",
+ "exactVersion": "aa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "test",
+ "createOption": "FromImage",
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "caching": "None",
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerName": "Test",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaaaaaaaaaaaaaaaaaaaaa",
+ "keyData": "aaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "requireGuestProvisionSignal": true
+ },
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2022-05-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "disableTcpStateTracking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 23,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "provisioningState": "Succeeded",
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "virtualMachineScaleSet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 26
+ },
+ "host": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "instanceView": {
+ "platformUpdateDomain": 1,
+ "platformFaultDomain": 29,
+ "computerName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "osName": "aaaaaaaaaaa",
+ "osVersion": "aaaaaaaaaaaaaa",
+ "hyperVGeneration": "V1",
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaa",
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
+ "preMaintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
+ "maintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
+ "maintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aa"
+ },
+ "disks": [
+ {
+ "name": "a",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ },
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "serialConsoleLogBlobUri": "aaaaaaaaaaaaaaaaaaa",
+ "status": {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ },
+ "assignedHost": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "patchStatus": {
+ "availablePatchSummary": {
+ "status": "Unknown",
+ "assessmentActivityId": "aaaaaaaaaaaaaaaaaaa",
+ "rebootPending": true,
+ "criticalAndSecurityPatchCount": 22,
+ "otherPatchCount": 25,
+ "startTime": "2022-01-14T16:43:41.682Z",
+ "lastModifiedTime": "2022-01-14T16:43:41.683Z",
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaaaa",
+ "message": "aaaaaaaaaaaaa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaa",
+ "target": "aaaaaaaaa",
+ "message": "aaa"
+ }
+ },
+ "lastPatchInstallationSummary": {
+ "status": "Unknown",
+ "installationActivityId": "aaaaaa",
+ "maintenanceWindowExceeded": true,
+ "notSelectedPatchCount": 20,
+ "excludedPatchCount": 1,
+ "pendingPatchCount": 2,
+ "installedPatchCount": 28,
+ "failedPatchCount": 30,
+ "startTime": "2022-01-14T16:43:41.683Z",
+ "lastModifiedTime": "2022-01-14T16:43:41.683Z",
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaaaa",
+ "message": "aaaaaaaaaaaaa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaa",
+ "target": "aaaaaaaaa",
+ "message": "aaa"
+ }
+ },
+ "configurationStatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ }
+ },
+ "licenseType": "aaaaaaaaaaaaaa",
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa",
+ "platformFaultDomain": 11,
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ },
+ "osImageNotificationProfile": {
+ "notBeforeTimeout": "PT15M",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaaaaaaaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaa",
+ "order": 4,
+ "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "timeCreated": "2022-01-14T16:43:41.685Z"
+ },
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "eastus",
+ "tags": {},
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
+ "name": "{virtualMachineName}",
+ "plan": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaa"
+ },
+ "resources": [
+ {
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaaa",
+ "substatuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaa",
+ "level": "Info",
+ "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "message": "aaaaaaaaaaaaaaaaaaa",
+ "time": "2022-01-14T16:43:41.657Z"
+ }
+ ]
+ },
+ "suppressFailures": true,
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaa",
+ "tags": {
+ "key9428": "aaaaaaa"
+ }
+ }
+ ],
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaaa",
+ "tenantId": "aaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key5688": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "clientId": "aaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaa",
+ "type": "EdgeZone"
+ }
+ }
+ ],
+ "nextLink": "a"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..38a4986ea1bb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_List_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus"
+ },
+ {
+ "location": "eastus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MaximumSet_Gen.json
new file mode 100644
index 000000000000..51a5bb7b049e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MinimumSet_Gen.json
new file mode 100644
index 000000000000..583bcffbf841
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MaximumSet_Gen.json
new file mode 100644
index 000000000000..6a7239dcc375
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "skipShutdown": true,
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MinimumSet_Gen.json
new file mode 100644
index 000000000000..c39efca2d4c6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_PowerOff_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MaximumSet_Gen.json
new file mode 100644
index 000000000000..73200cdd86b1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "a",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MinimumSet_Gen.json
new file mode 100644
index 000000000000..16e741f734aa
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Redeploy_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MaximumSet_Gen.json
new file mode 100644
index 000000000000..2e69f8896249
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e3a27d3e61a8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Restart_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MaximumSet_Gen.json
new file mode 100644
index 000000000000..2e69f8896249
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MinimumSet_Gen.json
new file mode 100644
index 000000000000..f1b8293f5e27
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExamples/VirtualMachines_Start_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmName": "aaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..e97bbff6142f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MaximumSet_Gen.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaa",
+ "version": "aaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "operatingSystem": "aaaaaaaaaaaaaaaaaa",
+ "computeRole": "aaaaaaaaaaaaaaaaa",
+ "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmScaleSetEnabled": true,
+ "supportsMultipleExtensions": true
+ },
+ "id": "aaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa",
+ "tags": {
+ "key9885": "aaaaaaaaa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..fdafe6d43c66
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aa",
+ "version": "aaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "aaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MaximumSet_Gen.json
new file mode 100644
index 000000000000..99fdf67555f1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MaximumSet_Gen.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "properties": {
+ "operatingSystem": "aaaaaaaaaaaaaaaaaa",
+ "computeRole": "aaaaaaaaaaaaaaaaa",
+ "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmScaleSetEnabled": true,
+ "supportsMultipleExtensions": true
+ },
+ "id": "aaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa",
+ "tags": {
+ "key9885": "aaaaaaaaa"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MinimumSet_Gen.json
new file mode 100644
index 000000000000..ee6d9d7f4c28
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "location": "aaaa",
+ "publisherName": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MaximumSet_Gen.json
new file mode 100644
index 000000000000..fb828caa4857
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MaximumSet_Gen.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaa",
+ "$filter": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "$top": 22,
+ "$orderby": "a",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "properties": {
+ "operatingSystem": "aaaaaaaaaaaaaaaaaa",
+ "computeRole": "aaaaaaaaaaaaaaaaa",
+ "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmScaleSetEnabled": true,
+ "supportsMultipleExtensions": true
+ },
+ "id": "aaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa",
+ "tags": {
+ "key9885": "aaaaaaaaa"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MinimumSet_Gen.json
new file mode 100644
index 000000000000..10ec2c37e861
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MinimumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "type": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..33a1d7c2c715
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "skus": "aaaaaaaaaa",
+ "version": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "plan": {
+ "publisher": "aaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaa",
+ "product": "aaaaaaaaaaaaaa"
+ },
+ "osDiskImage": {
+ "operatingSystem": "Windows"
+ },
+ "dataDiskImages": [
+ {
+ "lun": 17
+ }
+ ],
+ "automaticOSUpgradeProperties": {
+ "automaticOSUpgradeSupported": true
+ },
+ "hyperVGeneration": "V1",
+ "disallowed": {
+ "vmDiskType": "None"
+ },
+ "features": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "value": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ },
+ "name": "aaaaaaaaa",
+ "location": "aaaaa",
+ "tags": {
+ "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..cd753fc4250c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "offer": "aaaaaaaaaaa",
+ "skus": "aaaaaaaaaaaaaaaaaa",
+ "version": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "aaaaaaaaa",
+ "location": "aaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json
new file mode 100644
index 000000000000..43b77d9d2a82
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "location": "WestUS",
+ "edgeZone": "microsoftlosangeles1",
+ "api-version": "2022-11-01",
+ "subscriptionId": "5ece5940-d962-4dad-a98f-ca9ac0f021a5"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "18.04.202107200",
+ "location": "WestUS",
+ "extendedLocation": {
+ "name": "microsoftlosangeles1",
+ "type": "EdgeZone"
+ },
+ "id": "/Subscriptions/5ece5940-d962-4dad-a98f-ca9ac0f021a5/Providers/Microsoft.Compute/Locations/westus/Publishers/CANONICAL/ArtifactTypes/VMImage/Offers/UBUNTUSERVER/Skus/18_04-LTS-GEN2/Versions/18.04.202107200"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json
new file mode 100644
index 000000000000..548238da685d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "location": "WestUS",
+ "edgeZone": "microsoftlosangeles1",
+ "api-version": "2022-11-01",
+ "subscriptionId": "5ece5940-d962-4dad-a98f-ca9ac0f021a5"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": []
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json
new file mode 100644
index 000000000000..60a40a974827
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json
new file mode 100644
index 000000000000..6308eb17885d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json
new file mode 100644
index 000000000000..921becebe1af
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "location": "aaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json
new file mode 100644
index 000000000000..0c06db040feb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "location": "aaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json
new file mode 100644
index 000000000000..be54c072242c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaa",
+ "edgeZone": "aaaaa",
+ "publisherName": "aaaaaaaaaaaa",
+ "offer": "aaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json
new file mode 100644
index 000000000000..66a4ec9fe67f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaa",
+ "offer": "aaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..83d54cad6fac
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaa",
+ "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "skus": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "$expand": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "$top": 12,
+ "$orderby": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..0587a825f87d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "edgeZone": "aaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaa",
+ "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "skus": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..f363ff38c32f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MaximumSet_Gen.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "location": "aaaaaa",
+ "publisherName": "aaa",
+ "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "skus": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "version": "aaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "plan": {
+ "publisher": "aaaaaaaaaaaaaaaaaaa",
+ "name": "aaaaaaaaa",
+ "product": "aaaaaaaaaaaaaa"
+ },
+ "osDiskImage": {
+ "operatingSystem": "Windows"
+ },
+ "dataDiskImages": [
+ {
+ "lun": 17
+ }
+ ],
+ "automaticOSUpgradeProperties": {
+ "automaticOSUpgradeSupported": true
+ },
+ "hyperVGeneration": "V1",
+ "disallowed": {
+ "vmDiskType": "None"
+ },
+ "features": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "value": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "imageDeprecationStatus": {
+ "imageState": "ScheduledForDeprecation",
+ "scheduledDeprecationTime": "2023-01-13T00:00:00+00:00",
+ "alternativeOption": {
+ "type": "Offer",
+ "value": "aaaaaaa"
+ }
+ }
+ },
+ "name": "aaaaaaaaa",
+ "location": "aaaaa",
+ "tags": {
+ "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..a319377c21c1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_Get_MinimumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaa",
+ "offer": "aa",
+ "skus": "aaaaaaaaa",
+ "version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "aaaaaaaaa",
+ "location": "aaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8155fd7a701e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MaximumSet_Gen.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "location": "aaaaaaa",
+ "publisherName": "aaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e7db8cbca6c5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MaximumSet_Gen.json
new file mode 100644
index 000000000000..038b178b03ea
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MaximumSet_Gen.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "location": "aaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e96ea2e43027
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MaximumSet_Gen.json
new file mode 100644
index 000000000000..bd09cfc90c04
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MaximumSet_Gen.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "location": "aaaa",
+ "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "offer": "aaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MinimumSet_Gen.json
new file mode 100644
index 000000000000..d6ba569f6468
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MinimumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "location": "aaaa",
+ "publisherName": "aaaaaaaaaaaaa",
+ "offer": "aaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..a16aa5ec377e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MaximumSet_Gen.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "location": "aaaaaaaaaaaaaaa",
+ "publisherName": "aaaaaa",
+ "offer": "aaaaaaaaaaaaaaaa",
+ "skus": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "$expand": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "$top": 18,
+ "$orderby": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa",
+ "tags": {
+ "key7868": "aaaaa"
+ },
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "aaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..6040938855e4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineImageExamples/VirtualMachineImages_List_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "location": "aaaaaaa",
+ "publisherName": "aaaaaaaaaaa",
+ "offer": "aaaaaaaaaa",
+ "skus": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "aaaaaaaa",
+ "location": "aaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json
new file mode 100644
index 000000000000..1164e0641ed0
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MaximumSet_Gen.json
new file mode 100644
index 000000000000..33eca7e9483a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MaximumSet_Gen.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaa",
+ "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaa",
+ "extensionParameters": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MinimumSet_Gen.json
new file mode 100644
index 000000000000..1f7db4a4e636
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaa",
+ "vmssExtensionName": "aaaaaaaaaaa",
+ "extensionParameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MaximumSet_Gen.json
new file mode 100644
index 000000000000..3db66c76ceb8
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b2cc062acde3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MinimumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaa",
+ "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MaximumSet_Gen.json
new file mode 100644
index 000000000000..d34e8c4922b2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MaximumSet_Gen.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaa",
+ "$expand": "aaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MinimumSet_Gen.json
new file mode 100644
index 000000000000..48646550eb17
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MinimumSet_Gen.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "a",
+ "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..7462b2802fe6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MaximumSet_Gen.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ ],
+ "nextLink": "aa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..6df9da357a6b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {}
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..0a456577bf51
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MaximumSet_Gen.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmssExtensionName": "aaaa",
+ "extensionParameters": {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisioningState": "aaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "type": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..0ec9b15120a7
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmssExtensionName": "aa",
+ "extensionParameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ },
+ "201": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8d9eaefe0dfe
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MinimumSet_Gen.json
new file mode 100644
index 000000000000..62c768c9a1d3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MaximumSet_Gen.json
new file mode 100644
index 000000000000..01b67a7d90fc
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MaximumSet_Gen.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "policy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "rollbackFailedInstancesOnPolicyBreach": true,
+ "maxSurge": true
+ },
+ "runningStatus": {
+ "code": "RollingForward",
+ "startTime": "2021-11-30T13:06:23.362Z",
+ "lastAction": "Start",
+ "lastActionTime": "2021-11-30T13:06:23.362Z"
+ },
+ "progress": {
+ "successfulInstanceCount": 6,
+ "failedInstanceCount": 25,
+ "inProgressInstanceCount": 20,
+ "pendingInstanceCount": 27
+ },
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaa",
+ "message": "aa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaaa",
+ "target": "aaaaaaa",
+ "message": "aaaaaaaaa"
+ }
+ },
+ "id": "aaaaaaaaaa",
+ "name": "aaaaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaa",
+ "tags": {
+ "key8533": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MinimumSet_Gen.json
new file mode 100644
index 000000000000..bf204100bdd9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MinimumSet_Gen.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "aaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MaximumSet_Gen.json
new file mode 100644
index 000000000000..bb08e4b8cc64
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MaximumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MinimumSet_Gen.json
new file mode 100644
index 000000000000..35e551462aaf
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Create.json
new file mode 100644
index 000000000000..9bfd9d2cb513
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Create.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "vmExtensionName": "myVMExtension",
+ "api-version": "2022-11-01",
+ "extensionParameters": {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Delete.json
new file mode 100644
index 000000000000..ee261b96b99c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Delete.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "vmExtensionName": "myVMExtension",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Get.json
new file mode 100644
index 000000000000..f91f47afd15a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Get.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "vmExtensionName": "myVMExtension",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ },
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_List.json
new file mode 100644
index 000000000000..8985de1d0424
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_List.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ },
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension"
+ },
+ {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "extPublisher1",
+ "type": "extType1",
+ "typeHandlerVersion": "1.0",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ },
+ "name": "myVMExtension1",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Update.json
new file mode 100644
index 000000000000..7b85c3cc884a
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Update.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "vmExtensionName": "myVMExtension",
+ "api-version": "2022-11-01",
+ "extensionParameters": {
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVMExtension",
+ "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Creating",
+ "publisher": "extPublisher",
+ "type": "extType",
+ "typeHandlerVersion": "1.2",
+ "settings": {
+ "UserName": "xyz@microsoft.com"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json
new file mode 100644
index 000000000000..cc2b272dab62
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "forceDeletion": "true",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
new file mode 100644
index 000000000000..316e21b0350f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "instanceId": "0",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "platformUpdateDomain": 0,
+ "platformFaultDomain": 0,
+ "rdpThumbPrint": null,
+ "vmAgent": {
+ "vmAgentVersion": "Unknown",
+ "statuses": [
+ {
+ "code": "ProvisioningState/Unavailable",
+ "level": "Warning",
+ "displayStatus": "Not Ready",
+ "message": "VM status blob is found but not yet populated.",
+ "time": "2022-11-01T05:00:32+00:00"
+ }
+ ],
+ "extensionHandlers": null
+ },
+ "disks": [
+ {
+ "name": "myOSDisk",
+ "encryptionSettings": null,
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": null,
+ "time": "2022-11-01T04:58:58.0882815+00:00"
+ }
+ ]
+ }
+ ],
+ "extensions": null,
+ "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost",
+ "bootDiagnostics": null,
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": null,
+ "time": "2020-06-05T04:59:58.1852966+00:00"
+ },
+ {
+ "code": "PowerState/running",
+ "level": "Info",
+ "displayStatus": "VM running",
+ "message": null,
+ "time": null
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
new file mode 100644
index 000000000000..b987cae8b9ab
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json
@@ -0,0 +1,133 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "instanceId": "0",
+ "api-version": "2022-11-01",
+ "expand": "UserData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{vmss-vm-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "latestModelApplied": true,
+ "modelDefinitionApplied": "VirtualMachineScaleSet",
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": false,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": false,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
+ "hardwareProfile": {},
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "exactVersion": "4.127.20180315"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"
+ },
+ "diskSizeGB": 127
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "provisioningState": "Succeeded"
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "westus",
+ "tags": {
+ "displayName": "CustomScriptExtension-DSC"
+ },
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
new file mode 100644
index 000000000000..fcb78e8f932c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json
@@ -0,0 +1,138 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "instanceId": "0",
+ "api-version": "2022-11-01",
+ "expand": "UserData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{vmss-vm-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "properties": {
+ "latestModelApplied": true,
+ "modelDefinitionApplied": "VirtualMachineScaleSet",
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": false,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": false,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "exactVersion": "4.127.20180315"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"
+ },
+ "diskSizeGB": 127
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": false
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "provisioningState": "Succeeded"
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "westus",
+ "tags": {
+ "displayName": "CustomScriptExtension-DSC"
+ },
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json
new file mode 100644
index 000000000000..1747ca4653bb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ResourceGroup",
+ "api-version": "2022-11-01",
+ "vmScaleSetName": "myvmScaleSet",
+ "instanceId": "0",
+ "sasUriExpirationTimeInMinutes": 60
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "consoleScreenshotBlobUri": "https://storageuri/myvmScaleSetinstance.screenshot.bmp?{saskey}",
+ "serialConsoleLogBlobUri": "https://storageuri/myvmScaleSetinstance.serialconsole.log?{saskey}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json
new file mode 100644
index 000000000000..2c08d88f0db3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "ResourceGroup",
+ "vmScaleSetName": "VmScaleSetName",
+ "api-version": "2022-11-01",
+ "instanceId": "InstanceId"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MaximumSet_Gen.json
new file mode 100644
index 000000000000..401b5e90bd71
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MinimumSet_Gen.json
new file mode 100644
index 000000000000..e5e519b7aaed
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..468a561f0217
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MaximumSet_Gen.json
@@ -0,0 +1,547 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "virtualMachineScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "$filter": "aaaaaaaaaaaaaa",
+ "$select": "aaaaaaaaaaaaaaaaaaaaa",
+ "$expand": "aaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{vmss-vm-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "latestModelApplied": true,
+ "modelDefinitionApplied": "VirtualMachineScaleSet",
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": true,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4",
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaa"
+ }
+ ],
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaa"
+ }
+ ]
+ },
+ "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
+ "hardwareProfile": {
+ "vmSize": "Basic_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 9,
+ "vCPUsPerCore": 12
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "exactVersion": "4.127.20180315",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
+ "id": "a"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": true,
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diskIOPSReadWrite": 18,
+ "diskMBpsReadWrite": 29,
+ "detachOption": "ForceDetach",
+ "deleteOption": "Delete"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true,
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2020-11-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 2,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaa"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "instanceView": {
+ "platformUpdateDomain": 23,
+ "platformFaultDomain": 14,
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aaaaaa"
+ },
+ "disks": [
+ {
+ "name": "aaaaaaaaaaa",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "serialConsoleLogBlobUri": "aaaaaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "assignedHost": "aaaaaaa",
+ "placementGroupId": "aaa"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaa",
+ "protectionPolicy": {
+ "protectFromScaleIn": true,
+ "protectFromScaleSetActions": true
+ }
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "suppressFailures": true
+ }
+ }
+ ],
+ "instanceId": "aaaaaaaaaaaa",
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "zones": [
+ "a"
+ ]
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..5e66b58c0336
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MinimumSet_Gen.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "virtualMachineScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MaximumSet_Gen.json
new file mode 100644
index 000000000000..ae6fb293199e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MinimumSet_Gen.json
new file mode 100644
index 000000000000..013b5e8bac09
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaa",
+ "instanceId": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MaximumSet_Gen.json
new file mode 100644
index 000000000000..9a378a4df87f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MaximumSet_Gen.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaa",
+ "instanceId": "aaaaaaaaa",
+ "skipShutdown": true,
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MinimumSet_Gen.json
new file mode 100644
index 000000000000..900db87cc51b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8bc1aa1627d4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MinimumSet_Gen.json
new file mode 100644
index 000000000000..dceb29c57723
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MaximumSet_Gen.json
new file mode 100644
index 000000000000..fc221d66e963
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b07aa49ece31
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MaximumSet_Gen.json
new file mode 100644
index 000000000000..ce55ff47518b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MaximumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmScaleSetVMReimageInput": {
+ "tempDisk": true
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MinimumSet_Gen.json
new file mode 100644
index 000000000000..fe9d07ab0d6e
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaa",
+ "instanceId": "aaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MaximumSet_Gen.json
new file mode 100644
index 000000000000..b1f8921de08f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aa",
+ "instanceId": "aaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MinimumSet_Gen.json
new file mode 100644
index 000000000000..cb5408cb5520
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaa",
+ "instanceId": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MaximumSet_Gen.json
new file mode 100644
index 000000000000..2419b8279060
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MinimumSet_Gen.json
new file mode 100644
index 000000000000..6f258f8dd10f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..d6d085672b62
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MaximumSet_Gen.json
@@ -0,0 +1,1539 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": true,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4",
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaa"
+ }
+ ],
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaa"
+ }
+ ]
+ },
+ "hardwareProfile": {
+ "vmSize": "Basic_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 9,
+ "vCPUsPerCore": 12
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
+ "id": "a"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": true,
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "detachOption": "ForceDetach",
+ "deleteOption": "Delete"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true,
+ "adminPassword": "aaaaaaaaaaaaaaaa",
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2020-11-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 2,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaa"
+ }
+ },
+ "instanceView": {
+ "platformUpdateDomain": 23,
+ "platformFaultDomain": 14,
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aaaaaa"
+ },
+ "disks": [
+ {
+ "name": "aaaaaaaaaaa",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "bootDiagnostics": {
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "placementGroupId": "aaa"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaa",
+ "protectionPolicy": {
+ "protectFromScaleIn": true,
+ "protectFromScaleSetActions": true
+ }
+ },
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "{vmss-vm-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "latestModelApplied": true,
+ "modelDefinitionApplied": "VirtualMachineScaleSet",
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": true,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4",
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaa"
+ }
+ ],
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaa"
+ }
+ ]
+ },
+ "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
+ "hardwareProfile": {
+ "vmSize": "Basic_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 9,
+ "vCPUsPerCore": 12
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "exactVersion": "4.127.20180315",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
+ "id": "a"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": true,
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diskIOPSReadWrite": 18,
+ "diskMBpsReadWrite": 29,
+ "detachOption": "ForceDetach",
+ "deleteOption": "Delete"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true,
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2020-11-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 2,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaa"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "instanceView": {
+ "platformUpdateDomain": 23,
+ "platformFaultDomain": 14,
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aaaaaa"
+ },
+ "disks": [
+ {
+ "name": "aaaaaaaaaaa",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "serialConsoleLogBlobUri": "aaaaaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "assignedHost": "aaaaaaa",
+ "placementGroupId": "aaa"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaa",
+ "protectionPolicy": {
+ "protectFromScaleIn": true,
+ "protectFromScaleSetActions": true
+ }
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "suppressFailures": true
+ }
+ }
+ ],
+ "instanceId": "aaaaaaaaaaaa",
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "zones": [
+ "a"
+ ]
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "name": "{vmss-vm-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
+ "type": "Microsoft.Compute/virtualMachines",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "latestModelApplied": true,
+ "modelDefinitionApplied": "VirtualMachineScaleSet",
+ "networkProfileConfiguration": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": true,
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "vmsstestnetconfig9693",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
+ },
+ "privateIPAddressVersion": "IPv4",
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaa"
+ }
+ ],
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaa"
+ }
+ ]
+ },
+ "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
+ "hardwareProfile": {
+ "vmSize": "Basic_A0",
+ "vmSizeProperties": {
+ "vCPUsAvailable": 9,
+ "vCPUsPerCore": 12
+ }
+ },
+ "storageProfile": {
+ "imageReference": {
+ "publisher": "MicrosoftWindowsServer",
+ "offer": "WindowsServer",
+ "sku": "2012-R2-Datacenter",
+ "version": "4.127.20180315",
+ "exactVersion": "4.127.20180315",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
+ "id": "a"
+ },
+ "osDisk": {
+ "osType": "Windows",
+ "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "createOption": "FromImage",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 127,
+ "encryptionSettings": {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ },
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "deleteOption": "Delete"
+ },
+ "dataDisks": [
+ {
+ "lun": 1,
+ "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "createOption": "Empty",
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 128,
+ "toBeDetached": true,
+ "vhd": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "writeAcceleratorEnabled": true,
+ "diskIOPSReadWrite": 18,
+ "diskMBpsReadWrite": 29,
+ "detachOption": "ForceDetach",
+ "deleteOption": "Delete"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerName": "test000000",
+ "adminUsername": "Foo12",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [],
+ "allowExtensionOperations": true,
+ "requireGuestProvisionSignal": true,
+ "customData": "aaaa",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "networkProfile": {
+ "networkInterfaces": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete"
+ }
+ }
+ ],
+ "networkApiVersion": "2020-11-01",
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaaaaa",
+ "properties": {
+ "primary": true,
+ "deleteOption": "Delete",
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "enableIPForwarding": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaa"
+ ]
+ },
+ "ipConfigurations": [
+ {
+ "name": "aa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 2,
+ "deleteOption": "Delete",
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "publicIPAllocationMethod": "Dynamic"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ }
+ }
+ ],
+ "dscpConfiguration": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ }
+ }
+ ]
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaa"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "instanceView": {
+ "platformUpdateDomain": 23,
+ "platformFaultDomain": 14,
+ "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmAgent": {
+ "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "extensionHandlers": [
+ {
+ "type": "aaaaaaaaaaaaa",
+ "typeHandlerVersion": "aaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "maintenanceRedeployStatus": {
+ "isCustomerInitiatedMaintenanceAllowed": true,
+ "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
+ "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
+ "lastOperationResultCode": "None",
+ "lastOperationMessage": "aaaaaa"
+ },
+ "disks": [
+ {
+ "name": "aaaaaaaaaaa",
+ "encryptionSettings": [
+ {
+ "diskEncryptionKey": {
+ "secretUrl": "aaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "keyEncryptionKey": {
+ "keyUrl": "aaaaaaaaaaaaaa",
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "enabled": true
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ }
+ ],
+ "vmHealth": {
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "bootDiagnostics": {
+ "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "serialConsoleLogBlobUri": "aaaaaaaa",
+ "status": {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ },
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "assignedHost": "aaaaaaa",
+ "placementGroupId": "aaa"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "availabilitySet": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "licenseType": "aaaaaaaaaa",
+ "protectionPolicy": {
+ "protectFromScaleIn": true,
+ "protectFromScaleSetActions": true
+ }
+ },
+ "resources": [
+ {
+ "name": "CustomScriptExtension-DSC",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
+ "type": "Microsoft.Compute/virtualMachines/extensions",
+ "location": "westus",
+ "tags": {},
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "provisioningState": "Succeeded",
+ "publisher": "Microsoft.Compute",
+ "type": "CustomScriptExtension",
+ "typeHandlerVersion": "1.9",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "instanceView": {
+ "name": "aaaaaaaaaaaaaaaaa",
+ "type": "aaaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "substatuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ],
+ "statuses": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "level": "Info",
+ "displayStatus": "aaaaaa",
+ "message": "a",
+ "time": "2021-11-30T12:58:26.522Z"
+ }
+ ]
+ },
+ "suppressFailures": true
+ }
+ }
+ ],
+ "instanceId": "aaaaaaaaaaaa",
+ "sku": {
+ "name": "Classic",
+ "tier": "aaaaaaaaaaaaaa",
+ "capacity": 29
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "zones": [
+ "a"
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..c85a56a4d7b6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MinimumSet_Gen.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaa",
+ "instanceId": "aaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "location": "westus"
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ },
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json
new file mode 100644
index 000000000000..523f0340f497
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json
@@ -0,0 +1,242 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "ResourceDisk"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json
new file mode 100644
index 000000000000..f4c1265aa13f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json
@@ -0,0 +1,202 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "caching": "ReadWrite",
+ "image": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "osDisk"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "image": {
+ "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "osDisk"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "osType": "Windows",
+ "caching": "ReadWrite",
+ "image": {
+ "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd"
+ },
+ "createOption": "FromImage",
+ "name": "osDisk"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json
new file mode 100644
index 000000000000..974ea5eaf4a6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json
@@ -0,0 +1,204 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json
new file mode 100644
index 000000000000..4c9a7e282368
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json
@@ -0,0 +1,204 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json
new file mode 100644
index 000000000000..b045a1626488
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json
@@ -0,0 +1,183 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json
new file mode 100644
index 000000000000..fa8d1001fe62
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json
@@ -0,0 +1,277 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{nicConfig1-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "disableTcpStateTracking": true,
+ "enableAcceleratedNetworking": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ },
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "primary": false,
+ "enableAcceleratedNetworking": false,
+ "enableIPForwarding": false,
+ "disableTcpStateTracking": false,
+ "ipConfigurations": [
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{nicConfig1-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "disableTcpStateTracking": true,
+ "ipConfigurations": [
+ {
+ "name": "{nicConfig1-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": true
+ }
+ },
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": false,
+ "enableFpga": false,
+ "disableTcpStateTracking": false,
+ "ipConfigurations": [
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{nicConfig1-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "disableTcpStateTracking": true,
+ "ipConfigurations": [
+ {
+ "name": "{nicConfig1-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": true
+ }
+ },
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": false,
+ "enableFpga": false,
+ "disableTcpStateTracking": false,
+ "ipConfigurations": [
+ {
+ "name": "{nicConfig2-name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json
new file mode 100644
index 000000000000..3b41201f6597
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json
@@ -0,0 +1,271 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ },
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "primary": false,
+ "enableAcceleratedNetworking": false,
+ "enableIPForwarding": false,
+ "enableFpga": true,
+ "ipConfigurations": [
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ },
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": false,
+ "enableFpga": true,
+ "ipConfigurations": [
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ },
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": false,
+ "enableFpga": true,
+ "ipConfigurations": [
+ {
+ "name": "{fpgaNic-Name}",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json
new file mode 100644
index 000000000000..70d73c93cda3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json
@@ -0,0 +1,222 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "osDisk",
+ "vhdContainers": [
+ "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer",
+ "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer",
+ "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer",
+ "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer",
+ "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer"
+ ]
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "vhdContainers": [
+ "http://{existing-storage-account-name}.blob.core.windows.net/vhds"
+ ],
+ "name": "osDisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "vhdContainers": [
+ "http://{existing-storage-account-name}.blob.core.windows.net/vhds"
+ ],
+ "name": "osDisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json
new file mode 100644
index 000000000000..0201d28f3abe
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json
@@ -0,0 +1,230 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json
new file mode 100644
index 000000000000..6d9d3a06ca81
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config",
+ "treatFailureAsDeploymentFailure": true,
+ "enableAutomaticUpgrade": false
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json
new file mode 100644
index 000000000000..64ee04352843
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json
@@ -0,0 +1,227 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "PT10M"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "PT10M"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "PT10M"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json
new file mode 100644
index 000000000000..7f4c357351ed
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json
@@ -0,0 +1,230 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}"
+ }
+ ],
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool"
+ }
+ ],
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool"
+ }
+ ],
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json
new file mode 100644
index 000000000000..ad15ac48d3f5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json
@@ -0,0 +1,251 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ },
+ "publicIPAddressConfiguration": {
+ "name": "{vmss-name}",
+ "properties": {
+ "publicIPAddressVersion": "IPv4"
+ }
+ },
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool"
+ }
+ ],
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool"
+ }
+ ],
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json
new file mode 100644
index 000000000000..5e218791d989
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json
@@ -0,0 +1,233 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json
new file mode 100644
index 000000000000..b310cd2bfdb7
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json
@@ -0,0 +1,230 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json
new file mode 100644
index 000000000000..153a597548f1
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json
@@ -0,0 +1,239 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "diffDiskSettings": {
+ "option": "Local"
+ },
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json
new file mode 100644
index 000000000000..6e080ec36608
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json
@@ -0,0 +1,249 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ },
+ "diskControllerType": "NVMe"
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ },
+ "diskControllerType": "NVMe"
+ },
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ },
+ "diskControllerType": "SCSI"
+ },
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json
new file mode 100644
index 000000000000..0c77e15e770f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json
@@ -0,0 +1,255 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "createOption": "FromImage"
+ },
+ "dataDisks": [
+ {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}"
+ }
+ },
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json
new file mode 100644
index 000000000000..6ef805d59cd5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json
@@ -0,0 +1,270 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json
new file mode 100644
index 000000000000..10527b961ed2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json
@@ -0,0 +1,239 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows2016",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "windows-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "standard-data-science-vm",
+ "name": "standard-data-science-vm"
+ },
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "standard-data-science-vm",
+ "publisher": "microsoft-ads",
+ "version": "latest",
+ "offer": "standard-data-science-vm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "encryptionAtHost": true
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json
new file mode 100644
index 000000000000..8e4dbe77a054
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json
@@ -0,0 +1,278 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "suppressFailures": true
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "suppressFailures": true
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "suppressFailures": true
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json
new file mode 100644
index 000000000000..58f7ffa71627
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json
@@ -0,0 +1,278 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {}
+ }
+ }
+ ],
+ "extensionsTimeBudget": "PT1H20M"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {}
+ }
+ }
+ ],
+ "extensionsTimeBudget": "PT1H20M"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {}
+ }
+ }
+ ],
+ "extensionsTimeBudget": "PT1H20M"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json
new file mode 100644
index 000000000000..c4ff568514b4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json
@@ -0,0 +1,230 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json
new file mode 100644
index 000000000000..88fde54e2a67
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json
@@ -0,0 +1,233 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "osImageNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT15M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "osImageNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT15M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "osImageNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT15M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json
new file mode 100644
index 000000000000..5d757c26de82
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json
@@ -0,0 +1,215 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json
new file mode 100644
index 000000000000..3b213e0db25d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json
@@ -0,0 +1,215 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DS1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json
new file mode 100644
index 000000000000..e288b0ed6397
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json
@@ -0,0 +1,234 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 10,
+ "name": "Standard_A8m_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "singlePlacementGroup": false,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "orchestrationMode": "Flexible",
+ "priorityMixPolicy": {
+ "baseRegularPriorityCount": 4,
+ "regularPriorityPercentageAboveBase": 50
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 10,
+ "name": "Standard_A8m_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": false,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "orchestrationMode": "Flexible",
+ "priorityMixPolicy": {
+ "baseRegularPriorityCount": 4,
+ "regularPriorityPercentageAboveBase": 50
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 10,
+ "name": "Standard_A8m_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": false,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "orchestrationMode": "Flexible",
+ "priorityMixPolicy": {
+ "baseRegularPriorityCount": 4,
+ "regularPriorityPercentageAboveBase": 50
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json
new file mode 100644
index 000000000000..662145430ae5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json
@@ -0,0 +1,293 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": false,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "protectedSettingsFromKeyVault": {
+ "sourceVault": {
+ "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
+ },
+ "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
+ }
+ }
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json
new file mode 100644
index 000000000000..ca49ce9d14be
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json
@@ -0,0 +1,233 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "OldestVM"
+ ],
+ "forceDeletion": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "OldestVM"
+ ],
+ "forceDeletion": true
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "OldestVM"
+ ],
+ "forceDeletion": true
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json
new file mode 100644
index 000000000000..f2b1e4fe33a2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json
@@ -0,0 +1,245 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DC2as_v5"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly"
+ }
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DC2as_v5"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly"
+ }
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_DC2as_v5"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows-cvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "17763.2183.2109130127",
+ "offer": "2019-datacenter-cvm"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS",
+ "securityProfile": {
+ "securityEncryptionType": "VMGuestStateOnly"
+ }
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "ConfidentialVM"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json
new file mode 100644
index 000000000000..b3887ee74702
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json
@@ -0,0 +1,227 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_A1"
+ },
+ "location": "eastus2euap",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "serviceArtifactReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2022-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "createOption": "FromImage",
+ "name": "osDisk"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_A1"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64",
+ "virtualMachineProfile": {
+ "serviceArtifactReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2022-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "name": "osDisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true
+ }
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "eastus2euap",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_A1"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64",
+ "virtualMachineProfile": {
+ "serviceArtifactReference": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName"
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2022-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "name": "osDisk",
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true
+ }
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "eastus2euap",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json
new file mode 100644
index 000000000000..740d7a438ab0
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json
@@ -0,0 +1,242 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A8m_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "PT1H"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A8m_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "PT1H"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A8m_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "priority": "Spot",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "PT1H"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json
new file mode 100644
index 000000000000..9882fbaf8c26
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json
@@ -0,0 +1,239 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "16.04-LTS",
+ "publisher": "Canonical",
+ "version": "latest",
+ "offer": "UbuntuServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json
new file mode 100644
index 000000000000..c5e5e846bc5c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json
@@ -0,0 +1,233 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT5M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT5M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "enable": true,
+ "notBeforeTimeout": "PT5M"
+ }
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json
new file mode 100644
index 000000000000..5040b5ce26bf
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json
@@ -0,0 +1,236 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2s_v3"
+ },
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2s_v3"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D2s_v3"
+ },
+ "name": "{vmss-name}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "windows10-tvm",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "18363.592.2001092016",
+ "offer": "windowsserver-gen2preview-preview"
+ },
+ "osDisk": {
+ "caching": "ReadOnly",
+ "managedDisk": {
+ "storageAccountType": "StandardSSD_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json
new file mode 100644
index 000000000000..85e7f65cb93f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json
@@ -0,0 +1,228 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json
new file mode 100644
index 000000000000..377e68d329d5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json
@@ -0,0 +1,246 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": true,
+ "overprovision": true,
+ "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7",
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage"
+ }
+ },
+ "hardwareProfile": {
+ "vmSizeProperties": {
+ "vCPUsAvailable": 1,
+ "vCPUsPerCore": 1
+ }
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://nsgdiagnostic.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual"
+ },
+ "provisioningState": "Creating"
+ },
+ "location": "westus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json
new file mode 100644
index 000000000000..8467a20e84d6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json
@@ -0,0 +1,284 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "{vmss-name}",
+ "api-version": "2022-11-01",
+ "parameters": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A1_v2"
+ },
+ "location": "centralus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 0
+ },
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 1
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "adminPassword": "{your-password}"
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic"
+ }
+ },
+ "zones": [
+ "1",
+ "3"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": false,
+ "overprovision": true,
+ "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa",
+ "zoneBalance": false,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic"
+ },
+ "provisioningState": "Succeeded"
+ },
+ "zones": [
+ "1",
+ "3"
+ ],
+ "location": "centralus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ },
+ "201": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 2,
+ "name": "Standard_A1_v2"
+ },
+ "name": "{vmss-name}",
+ "properties": {
+ "singlePlacementGroup": false,
+ "overprovision": true,
+ "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa",
+ "zoneBalance": false,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "FromImage",
+ "diskSizeGB": 512
+ },
+ "dataDisks": [
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 0,
+ "diskSizeGB": 1023
+ },
+ {
+ "caching": "None",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS"
+ },
+ "createOption": "Empty",
+ "lun": 1,
+ "diskSizeGB": 1023
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "secrets": [],
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet"
+ },
+ "privateIPAddressVersion": "IPv4"
+ }
+ }
+ ],
+ "enableAcceleratedNetworking": false
+ }
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Automatic"
+ },
+ "provisioningState": "Creating"
+ },
+ "zones": [
+ "1",
+ "3"
+ ],
+ "location": "centralus",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json
new file mode 100644
index 000000000000..188ada948484
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myvmScaleSet",
+ "forceDeletion": "true",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {},
+ "202": {},
+ "204": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
new file mode 100644
index 000000000000..c012bd3733aa
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVirtualMachineScaleSet",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": []
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerNamePrefix": "myVirtualMachineScaleSet",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1,
+ "hostGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
+ },
+ "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
new file mode 100644
index 000000000000..d8ad7c133c24
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVirtualMachineScaleSet",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "West US",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerNamePrefix": "myVirtualMachineScaleSet",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1,
+ "hostGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
new file mode 100644
index 000000000000..5f4251165cd2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json
@@ -0,0 +1,108 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "api-version": "2022-11-01",
+ "$expand": "userData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVirtualMachineScaleSet",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": [],
+ "diskControllerType": "NVMe"
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerNamePrefix": "myVirtualMachineScaleSet",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1,
+ "hostGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
new file mode 100644
index 000000000000..811a1639ee53
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "resourceGroupName": "myResourceGroup",
+ "vmScaleSetName": "myVirtualMachineScaleSet",
+ "api-version": "2022-11-01",
+ "$expand": "userData"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "myVirtualMachineScaleSet",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "westus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": []
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "myTag1",
+ "order": 1,
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
+ "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
+ },
+ {
+ "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
+ }
+ ]
+ },
+ "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
+ "osProfile": {
+ "computerNamePrefix": "myVirtualMachineScaleSet",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1,
+ "hostGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MaximumSet_Gen.json
new file mode 100644
index 000000000000..7b5f24162014
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MaximumSet_Gen.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "activePlacementGroupId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MinimumSet_Gen.json
new file mode 100644
index 000000000000..8fdb93a5cade
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MinimumSet_Gen.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MaximumSet_Gen.json
new file mode 100644
index 000000000000..4ee9615ebe0f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MinimumSet_Gen.json
new file mode 100644
index 000000000000..ec31cabfb5b9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MaximumSet_Gen.json
new file mode 100644
index 000000000000..467192a459e2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MaximumSet_Gen.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "forceDeletion": true,
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MinimumSet_Gen.json
new file mode 100644
index 000000000000..b53ee05322a9
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json
new file mode 100644
index 000000000000..a9092e57e306
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}",
+ "platformUpdateDomain": 30
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "walkPerformed": true,
+ "nextPlatformUpdateDomain": 7
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json
new file mode 100644
index 000000000000..dd29f37b524c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}",
+ "platformUpdateDomain": 9
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json
new file mode 100644
index 000000000000..7b356aa74097
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "virtualMachine": {
+ "statusesSummary": [
+ {
+ "code": "aa",
+ "count": 21
+ }
+ ]
+ },
+ "extensions": [
+ {
+ "name": "aaaaaaaaaaa",
+ "statusesSummary": [
+ {
+ "code": "aa",
+ "count": 21
+ }
+ ]
+ }
+ ],
+ "statuses": [
+ {
+ "code": "ProvisioningState/succeeded",
+ "level": "Info",
+ "displayStatus": "Provisioning succeeded",
+ "message": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "time": "2021-11-30T12:58:26.526Z"
+ }
+ ],
+ "orchestrationServices": [
+ {
+ "serviceName": "AutomaticRepairs",
+ "serviceState": "NotRunning"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json
new file mode 100644
index 000000000000..0e89a4e40faa
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {}
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json
new file mode 100644
index 000000000000..4091aeaf65d7
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json
@@ -0,0 +1,80 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "runningStatus": {
+ "code": "RollingForward",
+ "startTime": "2021-11-30T13:05:40.442Z",
+ "endTime": "2021-11-30T13:05:40.443Z"
+ },
+ "progress": {
+ "successfulInstanceCount": 6,
+ "failedInstanceCount": 25,
+ "inProgressInstanceCount": 20,
+ "pendingInstanceCount": 27
+ },
+ "error": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaa",
+ "message": "aa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaaa",
+ "target": "aaaaaaa",
+ "message": "aaaaaaaaa"
+ },
+ "startedBy": "Unknown",
+ "targetImageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer",
+ "exactVersion": "aaaaaaa",
+ "sharedGalleryImageId": "aaaaaa",
+ "id": "aaaaaaaaaaaaaaaaaaa"
+ },
+ "rollbackInfo": {
+ "successfullyRolledbackInstanceCount": 12,
+ "failedRolledbackInstanceCount": 2,
+ "rollbackError": {
+ "details": [
+ {
+ "code": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "target": "aaaa",
+ "message": "aa"
+ }
+ ],
+ "innererror": {
+ "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "code": "aaaaaaa",
+ "target": "aaaaaaa",
+ "message": "aaaaaaaaa"
+ }
+ }
+ },
+ "type": "aaaaaaaaaaaaaaaaaaa",
+ "location": "aaaaaaaaaaaaa"
+ }
+ ],
+ "nextLink": "aaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json
new file mode 100644
index 000000000000..844cd8d6af7c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {}
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MaximumSet_Gen.json
new file mode 100644
index 000000000000..d70085daecbd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MaximumSet_Gen.json
@@ -0,0 +1,370 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer",
+ "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "id": "a"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "createOption": "FromImage",
+ "name": "aaaaaaaaaaaaaaa",
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "diskSizeGB": 30,
+ "osType": "Windows",
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "vhdContainers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "dataDisks": [
+ {
+ "name": "aaaaaaaaaaaaaa",
+ "lun": 24,
+ "caching": "None",
+ "writeAcceleratorEnabled": true,
+ "createOption": "FromImage",
+ "diskSizeGB": 11,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskIOPSReadWrite": 11,
+ "diskMBpsReadWrite": 13
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "{vmss-name}",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaaaaaa"
+ }
+ ],
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaa"
+ ]
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaaaaaaa"
+ }
+ ],
+ "healthProbe": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ },
+ "networkApiVersion": "2020-11-01"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "aa",
+ "type": "aaaaa",
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaaaaaaaaaaaaa",
+ "provisionAfterExtensions": [
+ "aaaaaaaaaaaaaa"
+ ],
+ "suppressFailures": true
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "licenseType": "aaaaaaaaaa",
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 4
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "aa",
+ "enable": true
+ }
+ },
+ "userData": "aaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaaaaaaaa",
+ "order": 29,
+ "packageReferenceId": "aaaaaaaaaa",
+ "configurationReference": "aaaaa"
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual",
+ "rollingUpgradePolicy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "rollbackFailedInstancesOnPolicyBreach": true,
+ "maxSurge": true
+ },
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true,
+ "disableAutomaticRollback": true
+ }
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "provisioningState": "succeeded",
+ "doNotRunExtensionsOnOverprovisionedVMs": true,
+ "uniqueId": "aaaaaaaa",
+ "singlePlacementGroup": true,
+ "zoneBalance": true,
+ "platformFaultDomainCount": 1,
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "Default"
+ ],
+ "forceDeletion": true
+ },
+ "orchestrationMode": "Uniform",
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "aaaaaaaaaa"
+ }
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "tenantId": "aaaaaaaaaaaaaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key3951": {
+ "principalId": "aaaa",
+ "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaaaaaaaaaaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
+ "name": "{virtualMachineScaleSetName}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "tags": {
+ "key8425": "aaa"
+ }
+ }
+ ],
+ "nextLink": "aaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MinimumSet_Gen.json
new file mode 100644
index 000000000000..3f2cfff0167b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "westus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListBySubscription_ByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListBySubscription_ByLocation.json
new file mode 100644
index 000000000000..82a184f787bd
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListBySubscription_ByLocation.json
@@ -0,0 +1,169 @@
+{
+ "parameters": {
+ "subscriptionId": "{subscription-id}",
+ "location": "eastus",
+ "api-version": "2022-11-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{virtualMachineScaleSetName}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "eastus",
+ "tags": {
+ "myTag1": "tagValue1"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerNamePrefix": "{virtualMachineScaleSetName}",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1
+ }
+ },
+ {
+ "name": "{virtualMachineScaleSetName}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "eastus",
+ "tags": {
+ "myTag1": "tagValue2"
+ },
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": false,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": false
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS"
+ },
+ "diskSizeGB": 30
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerNamePrefix": "{virtualMachineScaleSetName}",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": false
+ }
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic1",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ }
+ }
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ }
+ }
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": false,
+ "doNotRunExtensionsOnOverprovisionedVMs": false,
+ "platformFaultDomainCount": 1
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MaximumSet_Gen.json
new file mode 100644
index 000000000000..a78355304c18
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MaximumSet_Gen.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "aaaaaaaaaaaaaaaaa",
+ "sku": {
+ "name": "DSv3-Type1",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "capacity": {
+ "minimum": 22,
+ "maximum": 27,
+ "defaultCapacity": 20,
+ "scaleType": "Automatic"
+ }
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MinimumSet_Gen.json
new file mode 100644
index 000000000000..3b71dd151b0b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MinimumSet_Gen.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {}
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MaximumSet_Gen.json
new file mode 100644
index 000000000000..fb0f16ff7fd3
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MaximumSet_Gen.json
@@ -0,0 +1,689 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "{virtualMachineScaleSetName}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "eastus",
+ "tags": {},
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": true,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true,
+ "disableAutomaticRollback": true,
+ "useRollingUpgradePolicy": true
+ },
+ "rollingUpgradePolicy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "rollbackFailedInstancesOnPolicyBreach": true,
+ "maxSurge": true
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 30,
+ "name": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "osType": "Windows",
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "vhdContainers": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2",
+ "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa",
+ "id": "aaaaaaaaaa"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerNamePrefix": "{virtualMachineScaleSetName}",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "customData": "aaaaaaaaaaaaaaaaaa",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ },
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaaaaaaaa"
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ },
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaa"
+ ]
+ },
+ "enableIPForwarding": true,
+ "deleteOption": "Delete"
+ },
+ "id": "aa"
+ }
+ ],
+ "healthProbe": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ },
+ "networkApiVersion": "2020-11-01"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "aa",
+ "type": "aaaaa",
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaaaaaaaaaaaaa",
+ "provisionAfterExtensions": [
+ "aaaaaaaaaaaaaa"
+ ],
+ "suppressFailures": true
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "licenseType": "aaaa",
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 4
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "aa",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaaaaaaaaaaaaaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaaaaaaaa",
+ "order": 29,
+ "packageReferenceId": "aaaaaaaaaa",
+ "configurationReference": "aaaaa"
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": true,
+ "doNotRunExtensionsOnOverprovisionedVMs": true,
+ "platformFaultDomainCount": 1,
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "uniqueId": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "zoneBalance": true,
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "Default"
+ ],
+ "forceDeletion": true
+ },
+ "orchestrationMode": "Uniform",
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "aaaaaaaaaa"
+ }
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "tenantId": "aaaaaaaaaaaaaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key3951": {
+ "principalId": "aaaa",
+ "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ }
+ },
+ {
+ "name": "{virtualMachineScaleSetName}",
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "location": "eastus",
+ "tags": {},
+ "sku": {
+ "name": "Standard_D2s_v3",
+ "tier": "Standard",
+ "capacity": 4
+ },
+ "properties": {
+ "singlePlacementGroup": true,
+ "upgradePolicy": {
+ "mode": "Automatic",
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true,
+ "disableAutomaticRollback": true,
+ "useRollingUpgradePolicy": true
+ },
+ "rollingUpgradePolicy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "maxSurge": true
+ }
+ },
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "osDisk": {
+ "createOption": "FromImage",
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Premium_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskSizeGB": 30,
+ "name": "a",
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "osType": "Windows",
+ "image": {
+ "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
+ },
+ "vhdContainers": [
+ "aaaaaaaaaaaaaaaa"
+ ]
+ },
+ "imageReference": {
+ "publisher": "azuredatabricks",
+ "offer": "databricks",
+ "sku": "databricksworker",
+ "version": "3.15.2",
+ "exactVersion": "aa",
+ "sharedGalleryImageId": "aaaaaaa",
+ "id": "aaa"
+ },
+ "dataDisks": []
+ },
+ "osProfile": {
+ "computerNamePrefix": "{virtualMachineScaleSetName}",
+ "adminUsername": "admin",
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "aaa",
+ "keyData": "aaaaaa"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "customData": "a",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "Manual",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault"
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "myNic1",
+ "properties": {
+ "primary": true,
+ "ipConfigurations": [
+ {
+ "name": "myIPConfig",
+ "properties": {
+ "primary": true,
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
+ },
+ "publicIPAddressConfiguration": {
+ "name": "aaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "idleTimeoutInMinutes": 18,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ ]
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "networkSecurityGroup": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
+ },
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaa"
+ ]
+ },
+ "enableIPForwarding": true,
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "healthProbe": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
+ },
+ "networkApiVersion": "2020-11-01"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "aaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "aa",
+ "type": "aaaaa",
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaa",
+ "type": "aaaaaaaa",
+ "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaaaaaaaaaaaaa",
+ "provisionAfterExtensions": [
+ "aaaaaaaaaaaaaa"
+ ],
+ "suppressFailures": true
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "licenseType": "aaaaaaaaaaaaaaaaaaaaaaa",
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": 4
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "aa",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaaaaaaaaaaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaaaaaaaa",
+ "order": 29,
+ "packageReferenceId": "aaaaaaaaaa",
+ "configurationReference": "aaaaa"
+ }
+ ]
+ }
+ },
+ "provisioningState": "succeeded",
+ "overprovision": true,
+ "doNotRunExtensionsOnOverprovisionedVMs": true,
+ "platformFaultDomainCount": 1,
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ },
+ "uniqueId": "aaaaa",
+ "zoneBalance": true,
+ "proximityPlacementGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "Default"
+ ],
+ "forceDeletion": true
+ },
+ "orchestrationMode": "Uniform",
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "aaaaaaaaaa"
+ }
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "tenantId": "aaaaaaaaaaaaaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key3951": {
+ "principalId": "aaaa",
+ "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ }
+ }
+ ],
+ "nextLink": "aaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MinimumSet_Gen.json
new file mode 100644
index 000000000000..38a4986ea1bb
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus"
+ },
+ {
+ "location": "eastus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MaximumSet_Gen.json
new file mode 100644
index 000000000000..1ed765d1aa64
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MinimumSet_Gen.json
new file mode 100644
index 000000000000..cbb397cfa550
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MaximumSet_Gen.json
new file mode 100644
index 000000000000..e53d580fffda
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MaximumSet_Gen.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "skipShutdown": true,
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MinimumSet_Gen.json
new file mode 100644
index 000000000000..9ae289cc1b20
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "a",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MaximumSet_Gen.json
new file mode 100644
index 000000000000..24e0f1f6e6a4
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MinimumSet_Gen.json
new file mode 100644
index 000000000000..61e6bf7bf93f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MaximumSet_Gen.json
new file mode 100644
index 000000000000..4528e7fbc80d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MinimumSet_Gen.json
new file mode 100644
index 000000000000..61e6bf7bf93f
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MaximumSet_Gen.json
new file mode 100644
index 000000000000..dab6740afa7b
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MaximumSet_Gen.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmScaleSetReimageInput": {
+ "instanceIds": [
+ "aaaaaaaaaa"
+ ],
+ "tempDisk": true
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MinimumSet_Gen.json
new file mode 100644
index 000000000000..a8caea8d83fa
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MaximumSet_Gen.json
new file mode 100644
index 000000000000..8c683c9079af
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MinimumSet_Gen.json
new file mode 100644
index 000000000000..bb08e4b8cc64
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MaximumSet_Gen.json
new file mode 100644
index 000000000000..206e7e36df2d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MaximumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaa",
+ "parameters": {
+ "serviceName": "AutomaticRepairs",
+ "action": "Resume"
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MinimumSet_Gen.json
new file mode 100644
index 000000000000..0924e31c2706
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MinimumSet_Gen.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "parameters": {
+ "serviceName": "AutomaticRepairs",
+ "action": "Resume"
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MaximumSet_Gen.json
new file mode 100644
index 000000000000..66199c4b2de5
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MinimumSet_Gen.json
new file mode 100644
index 000000000000..fff78df0eec6
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaa",
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MaximumSet_Gen.json
new file mode 100644
index 000000000000..218932311a19
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MaximumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MinimumSet_Gen.json
new file mode 100644
index 000000000000..2c980b2d2246
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MinimumSet_Gen.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "vmInstanceIDs": {
+ "instanceIds": [
+ "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ ]
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://foo.com/operationstatus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MaximumSet_Gen.json
new file mode 100644
index 000000000000..e9b73e203637
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MaximumSet_Gen.json
@@ -0,0 +1,653 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaa",
+ "parameters": {
+ "sku": {
+ "name": "DSv3-Type1",
+ "tier": "aaa",
+ "capacity": 7
+ },
+ "plan": {
+ "publisher": "microsoft-ads",
+ "product": "windows-data-science-vm",
+ "name": "windows2016",
+ "promotionCode": "aaaaaaaaaa"
+ },
+ "properties": {
+ "upgradePolicy": {
+ "mode": "Manual",
+ "rollingUpgradePolicy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "rollbackFailedInstancesOnPolicyBreach": true,
+ "maxSurge": true
+ },
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true,
+ "disableAutomaticRollback": true
+ }
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "PT30M"
+ },
+ "virtualMachineProfile": {
+ "osProfile": {
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ },
+ "timeZone": "aaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "linuxConfiguration": {
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "disablePasswordAuthentication": true,
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ]
+ },
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer",
+ "sharedGalleryImageId": "aaaaaa",
+ "id": "aaaaaaaaaaaaaaaaaaa"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "writeAcceleratorEnabled": true,
+ "diskSizeGB": 6,
+ "image": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
+ },
+ "vhdContainers": [
+ "aa"
+ ],
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ }
+ },
+ "dataDisks": [
+ {
+ "diskSizeGB": 1023,
+ "createOption": "Empty",
+ "lun": 26,
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "caching": "None",
+ "writeAcceleratorEnabled": true,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskIOPSReadWrite": 28,
+ "diskMBpsReadWrite": 15
+ }
+ ]
+ },
+ "networkProfile": {
+ "healthProbe": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ },
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "dnsSettings": {
+ "dnsServers": []
+ },
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "a",
+ "properties": {
+ "idleTimeoutInMinutes": 3,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "deleteOption": "Delete"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ]
+ },
+ "id": "aaaaaaaaaaaaaaaa"
+ }
+ ],
+ "enableIPForwarding": true,
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "networkApiVersion": "2020-11-01"
+ },
+ "securityProfile": {
+ "encryptionAtHost": true,
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
+ "enabled": true
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "properties": {
+ "autoUpgradeMinorVersion": true,
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "settings": {},
+ "forceUpdateTag": "aaaaaaaaa",
+ "enableAutomaticUpgrade": true,
+ "protectedSettings": {},
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ }
+ }
+ ],
+ "extensionsTimeBudget": "PT1H20M"
+ },
+ "licenseType": "aaaaaaaaaaaa",
+ "billingProfile": {
+ "maxPrice": -1
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaa"
+ },
+ "overprovision": true,
+ "doNotRunExtensionsOnOverprovisionedVMs": true,
+ "singlePlacementGroup": true,
+ "additionalCapabilities": {
+ "hibernationEnabled": true,
+ "ultraSSDEnabled": true
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "OldestVM"
+ ],
+ "forceDeletion": true
+ },
+ "proximityPlacementGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key3951": {}
+ }
+ },
+ "tags": {
+ "key246": "aaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ },
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "sku": {
+ "tier": "Standard",
+ "capacity": 3,
+ "name": "Standard_D1_v2"
+ },
+ "location": "westus",
+ "properties": {
+ "overprovision": true,
+ "virtualMachineProfile": {
+ "storageProfile": {
+ "imageReference": {
+ "sku": "2016-Datacenter",
+ "publisher": "MicrosoftWindowsServer",
+ "version": "latest",
+ "offer": "WindowsServer",
+ "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "sharedGalleryImageId": "aaaaaa",
+ "id": "aaaaaaaaaaaaaaaaaaa"
+ },
+ "osDisk": {
+ "caching": "ReadWrite",
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "createOption": "FromImage",
+ "name": "aaaaaaaaaaaaaaa",
+ "writeAcceleratorEnabled": true,
+ "diffDiskSettings": {
+ "option": "Local",
+ "placement": "CacheDisk"
+ },
+ "diskSizeGB": 6,
+ "osType": "Windows",
+ "image": {
+ "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd"
+ },
+ "vhdContainers": [
+ "aa"
+ ]
+ },
+ "dataDisks": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "lun": 26,
+ "caching": "None",
+ "writeAcceleratorEnabled": true,
+ "createOption": "Empty",
+ "diskSizeGB": 1023,
+ "managedDisk": {
+ "storageAccountType": "Standard_LRS",
+ "diskEncryptionSet": {
+ "id": "aaaaaaaaaaaa"
+ }
+ },
+ "diskIOPSReadWrite": 28,
+ "diskMBpsReadWrite": 15
+ }
+ ]
+ },
+ "osProfile": {
+ "computerNamePrefix": "{vmss-name}",
+ "adminUsername": "{your-username}",
+ "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "windowsConfiguration": {
+ "provisionVMAgent": true,
+ "enableAutomaticUpdates": true,
+ "timeZone": "aaaaaaaaaaaaaaaa",
+ "additionalUnattendContent": [
+ {
+ "passName": "OobeSystem",
+ "componentName": "Microsoft-Windows-Shell-Setup",
+ "settingName": "AutoLogon",
+ "content": "aaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "patchSettings": {
+ "patchMode": "AutomaticByPlatform",
+ "enableHotpatching": true,
+ "assessmentMode": "ImageDefault",
+ "automaticByPlatformSettings": {
+ "rebootSetting": "Never"
+ }
+ },
+ "winRM": {
+ "listeners": [
+ {
+ "protocol": "Http",
+ "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ },
+ "linuxConfiguration": {
+ "disablePasswordAuthentication": true,
+ "ssh": {
+ "publicKeys": [
+ {
+ "path": "/home/{your-username}/.ssh/authorized_keys",
+ "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1"
+ }
+ ]
+ },
+ "provisionVMAgent": true,
+ "patchSettings": {
+ "patchMode": "ImageDefault",
+ "assessmentMode": "ImageDefault"
+ }
+ },
+ "secrets": [
+ {
+ "sourceVault": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "vaultCertificates": [
+ {
+ "certificateUrl": "aaaaaaa",
+ "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ]
+ }
+ ]
+ },
+ "networkProfile": {
+ "networkInterfaceConfigurations": [
+ {
+ "name": "aaaaaaaa",
+ "properties": {
+ "primary": true,
+ "enableIPForwarding": true,
+ "ipConfigurations": [
+ {
+ "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ "properties": {
+ "subnet": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ },
+ "primary": true,
+ "publicIPAddressConfiguration": {
+ "name": "a",
+ "properties": {
+ "idleTimeoutInMinutes": 3,
+ "dnsSettings": {
+ "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
+ },
+ "ipTags": [
+ {
+ "ipTagType": "aaaaaaa",
+ "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "publicIPPrefix": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "publicIPAddressVersion": "IPv4",
+ "deleteOption": "Delete"
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Regional"
+ }
+ },
+ "privateIPAddressVersion": "IPv4",
+ "applicationGatewayBackendAddressPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "applicationSecurityGroups": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "loadBalancerBackendAddressPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ],
+ "loadBalancerInboundNatPools": [
+ {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ }
+ ]
+ },
+ "id": "aaaaaaaaaaaaaaaa"
+ }
+ ],
+ "enableAcceleratedNetworking": true,
+ "enableFpga": true,
+ "networkSecurityGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "dnsSettings": {
+ "dnsServers": [
+ "aaaaaaaaaaaa"
+ ]
+ },
+ "deleteOption": "Delete"
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "healthProbe": {
+ "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
+ },
+ "networkApiVersion": "2020-11-01"
+ },
+ "securityProfile": {
+ "uefiSettings": {
+ "secureBootEnabled": true,
+ "vTpmEnabled": true
+ },
+ "encryptionAtHost": true,
+ "securityType": "TrustedLaunch"
+ },
+ "diagnosticsProfile": {
+ "bootDiagnostics": {
+ "enabled": true,
+ "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net"
+ }
+ },
+ "extensionProfile": {
+ "extensions": [
+ {
+ "name": "{extension-name}",
+ "type": "aaaaa",
+ "properties": {
+ "forceUpdateTag": "aaaaaaaaa",
+ "publisher": "{extension-Publisher}",
+ "type": "{extension-Type}",
+ "typeHandlerVersion": "{handler-version}",
+ "autoUpgradeMinorVersion": true,
+ "enableAutomaticUpgrade": true,
+ "settings": {},
+ "protectedSettings": {},
+ "provisioningState": "aaaaaaaaaaaaaa",
+ "provisionAfterExtensions": [
+ "aa"
+ ],
+ "suppressFailures": true
+ },
+ "id": "aaaaaaaaaaaaaaaaaaaaaa"
+ }
+ ],
+ "extensionsTimeBudget": "PT1H20M"
+ },
+ "licenseType": "aaaaaaaaaaaa",
+ "priority": "Regular",
+ "evictionPolicy": "Deallocate",
+ "billingProfile": {
+ "maxPrice": -1
+ },
+ "scheduledEventsProfile": {
+ "terminateNotificationProfile": {
+ "notBeforeTimeout": "PT10M",
+ "enable": true
+ }
+ },
+ "userData": "aaaaaaaaaaaaa",
+ "capacityReservation": {
+ "capacityReservationGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ }
+ },
+ "applicationProfile": {
+ "galleryApplications": [
+ {
+ "tags": "aaaaaaaaaaa",
+ "order": 29,
+ "packageReferenceId": "aaaaaaaaaa",
+ "configurationReference": "aaaaa"
+ }
+ ]
+ }
+ },
+ "upgradePolicy": {
+ "mode": "Manual",
+ "rollingUpgradePolicy": {
+ "maxBatchInstancePercent": 49,
+ "maxUnhealthyInstancePercent": 81,
+ "maxUnhealthyUpgradedInstancePercent": 98,
+ "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
+ "enableCrossZoneUpgrade": true,
+ "prioritizeUnhealthyInstances": true,
+ "maxSurge": true
+ },
+ "automaticOSUpgradePolicy": {
+ "enableAutomaticOSUpgrade": true,
+ "disableAutomaticRollback": true
+ }
+ },
+ "automaticRepairsPolicy": {
+ "enabled": true,
+ "gracePeriod": "PT30M"
+ },
+ "provisioningState": "succeeded",
+ "doNotRunExtensionsOnOverprovisionedVMs": true,
+ "uniqueId": "aaaaaaaa",
+ "singlePlacementGroup": true,
+ "zoneBalance": true,
+ "platformFaultDomainCount": 1,
+ "proximityPlacementGroup": {
+ "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot"
+ },
+ "hostGroup": {
+ "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
+ },
+ "additionalCapabilities": {
+ "ultraSSDEnabled": true,
+ "hibernationEnabled": true
+ },
+ "scaleInPolicy": {
+ "rules": [
+ "OldestVM"
+ ],
+ "forceDeletion": true
+ },
+ "orchestrationMode": "Uniform",
+ "spotRestorePolicy": {
+ "enabled": true,
+ "restoreTimeout": "aaaaaaaaaa"
+ }
+ },
+ "plan": {
+ "name": "aaaaaaaaaa",
+ "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
+ "product": "aaaaaaaaaaaaaaaaaaaa",
+ "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
+ },
+ "identity": {
+ "principalId": "aaaaaaaaaaaaaaa",
+ "tenantId": "aaaaaaaaaaaaaaaa",
+ "type": "SystemAssigned",
+ "userAssignedIdentities": {
+ "key3951": {
+ "principalId": "aaaa",
+ "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
+ }
+ }
+ },
+ "zones": [
+ "aaaaaaaaaaaaaaaaaaaa"
+ ],
+ "extendedLocation": {
+ "name": "aaaaaaaaaaaaaaaaaaaaa",
+ "type": "EdgeZone"
+ },
+ "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
+ "name": "{virtualMachineScaleSetName}",
+ "type": "Microsoft.Compute/virtualMachineScaleSets",
+ "tags": {
+ "key8425": "aaa"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MinimumSet_Gen.json
new file mode 100644
index 000000000000..4e9d1616233d
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MinimumSet_Gen.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "resourceGroupName": "rgcompute",
+ "vmScaleSetName": "aaaaaaaaaaaaaa",
+ "parameters": {},
+ "api-version": "2022-11-01",
+ "subscriptionId": "{subscription-id}"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "westus"
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/image.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/image.json
new file mode 100644
index 000000000000..a3c417cb8748
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/image.json
@@ -0,0 +1,597 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": {
+ "put": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_CreateOrUpdate",
+ "description": "Create or update an image.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "imageName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the image."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Image"
+ },
+ "description": "Parameters supplied to the Create Image operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Image"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/Image"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a virtual machine image from a blob.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromABlob.json"
+ },
+ "Create a virtual machine image from a snapshot.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromASnapshot.json"
+ },
+ "Create a virtual machine image from a managed disk.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromAManagedDisk.json"
+ },
+ "Create a virtual machine image from an existing virtual machine.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromAVM.json"
+ },
+ "Create a virtual machine image that includes a data disk from a blob.": {
+ "$ref": "./examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json"
+ },
+ "Create a virtual machine image that includes a data disk from a snapshot.": {
+ "$ref": "./examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json"
+ },
+ "Create a virtual machine image that includes a data disk from a managed disk.": {
+ "$ref": "./examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json"
+ },
+ "Create a virtual machine image from a blob with DiskEncryptionSet resource.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json"
+ },
+ "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json"
+ },
+ "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": {
+ "$ref": "./examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_Update",
+ "description": "Update an image.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "imageName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the image."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImageUpdate"
+ },
+ "description": "Parameters supplied to the Update Image operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Image"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/Image"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Updates tags of an Image.": {
+ "$ref": "./examples/imageExamples/Image_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_Delete",
+ "description": "Deletes an Image.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "imageName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the image."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Images_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/imageExamples/Images_Delete_MaximumSet_Gen.json"
+ },
+ "Images_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/imageExamples/Images_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_Get",
+ "description": "Gets an image.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "imageName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the image."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Image"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get information about a virtual machine image.": {
+ "$ref": "./examples/imageExamples/Image_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": {
+ "get": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_ListByResourceGroup",
+ "description": "Gets the list of images under a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List all virtual machine images in a resource group.": {
+ "$ref": "./examples/imageExamples/Image_ListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": {
+ "get": {
+ "tags": [
+ "Images"
+ ],
+ "operationId": "Images_List",
+ "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ImageListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List all virtual machine images in a subscription.": {
+ "$ref": "./examples/imageExamples/Image_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ImageOSDisk": {
+ "properties": {
+ "osType": {
+ "type": "string",
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.
Possible values are:
**Windows**
**Linux**",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemTypes",
+ "modelAsString": false
+ }
+ },
+ "osState": {
+ "type": "string",
+ "description": "The OS State. For managed images, use Generalized.",
+ "enum": [
+ "Generalized",
+ "Specialized"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemStateTypes",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Generalized",
+ "description": "Generalized image. Needs to be provisioned during deployment time."
+ },
+ {
+ "value": "Specialized",
+ "description": "Specialized image. Contains already provisioned OS Disk."
+ }
+ ]
+ }
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ImageDisk"
+ }
+ ],
+ "required": [
+ "osType",
+ "osState"
+ ],
+ "description": "Describes an Operating System disk."
+ },
+ "ImageDataDisk": {
+ "properties": {
+ "lun": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/ImageDisk"
+ }
+ ],
+ "required": [
+ "lun"
+ ],
+ "description": "Describes a data disk."
+ },
+ "ImageDisk": {
+ "properties": {
+ "snapshot": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The snapshot."
+ },
+ "managedDisk": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The managedDisk."
+ },
+ "blobUri": {
+ "type": "string",
+ "description": "The Virtual Hard Disk."
+ },
+ "caching": {
+ "type": "string",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None for Standard storage. ReadOnly for Premium storage**",
+ "enum": [
+ "None",
+ "ReadOnly",
+ "ReadWrite"
+ ],
+ "x-ms-enum": {
+ "name": "CachingTypes",
+ "modelAsString": false
+ }
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.
This value cannot be larger than 1023 GB"
+ },
+ "storageAccountType": {
+ "$ref": "./computeRPCommon.json#/definitions/StorageAccountType",
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters",
+ "description": "Specifies the customer managed disk encryption set resource id for the managed image disk."
+ }
+ },
+ "description": "Describes a image disk."
+ },
+ "ImageStorageProfile": {
+ "properties": {
+ "osDisk": {
+ "$ref": "#/definitions/ImageOSDisk",
+ "description": "Specifies information about the operating system disk used by the virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImageDataDisk"
+ },
+ "x-ms-identifiers": [
+ "lun"
+ ],
+ "description": "Specifies the parameters that are used to add a data disk to a virtual machine.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "zoneResilient": {
+ "type": "boolean",
+ "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)."
+ }
+ },
+ "description": "Describes a storage profile."
+ },
+ "ImageProperties": {
+ "properties": {
+ "sourceVirtualMachine": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The source virtual machine from which Image is created."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/ImageStorageProfile",
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state."
+ },
+ "hyperVGeneration": {
+ "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType",
+ "description": "Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource."
+ }
+ },
+ "description": "Describes the properties of an Image."
+ },
+ "Image": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ImageProperties"
+ },
+ "extendedLocation": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation",
+ "description": "The extended location of the Image."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
+ },
+ "ImageUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ImageProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "The source user image virtual hard disk. Only tags may be updated."
+ },
+ "ImageListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Image"
+ },
+ "description": "The list of Images."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Image operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/logAnalytic.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/logAnalytic.json
new file mode 100644
index 000000000000..72cb37098519
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/logAnalytic.json
@@ -0,0 +1,259 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": {
+ "post": {
+ "tags": [
+ "LogAnalytics"
+ ],
+ "operationId": "LogAnalytics_ExportRequestRateByInterval",
+ "x-ms-examples": {
+ "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": {
+ "$ref": "./examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json"
+ }
+ },
+ "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RequestRateByIntervalInput"
+ },
+ "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api."
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location upon which virtual-machine-sizes is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/LogAnalyticsOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": {
+ "post": {
+ "tags": [
+ "LogAnalytics"
+ ],
+ "operationId": "LogAnalytics_ExportThrottledRequests",
+ "x-ms-examples": {
+ "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": {
+ "$ref": "./examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json"
+ }
+ },
+ "description": "Export logs that show total throttled Api requests for this subscription in the given time window.",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ThrottledRequestsInput"
+ },
+ "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api."
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location upon which virtual-machine-sizes is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/LogAnalyticsOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "RequestRateByIntervalInput": {
+ "properties": {
+ "intervalLength": {
+ "type": "string",
+ "description": "Interval value in minutes used to create LogAnalytics call rate logs.",
+ "enum": [
+ "ThreeMins",
+ "FiveMins",
+ "ThirtyMins",
+ "SixtyMins"
+ ],
+ "x-ms-enum": {
+ "name": "IntervalInMins",
+ "modelAsString": false
+ }
+ }
+ },
+ "required": [
+ "intervalLength"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/LogAnalyticsInputBase"
+ }
+ ],
+ "description": "Api request input for LogAnalytics getRequestRateByInterval Api."
+ },
+ "ThrottledRequestsInput": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/LogAnalyticsInputBase"
+ }
+ ],
+ "description": "Api request input for LogAnalytics getThrottledRequests Api."
+ },
+ "LogAnalyticsInputBase": {
+ "properties": {
+ "blobContainerSasUri": {
+ "type": "string",
+ "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to."
+ },
+ "fromTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "From time of the query"
+ },
+ "toTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "To time of the query"
+ },
+ "groupByThrottlePolicy": {
+ "type": "boolean",
+ "description": "Group query result by Throttle Policy applied."
+ },
+ "groupByOperationName": {
+ "type": "boolean",
+ "description": "Group query result by Operation Name."
+ },
+ "groupByResourceName": {
+ "type": "boolean",
+ "description": "Group query result by Resource Name."
+ },
+ "groupByClientApplicationId": {
+ "type": "boolean",
+ "description": "Group query result by Client Application ID."
+ },
+ "groupByUserAgent": {
+ "type": "boolean",
+ "description": "Group query result by User Agent."
+ }
+ },
+ "required": [
+ "blobContainerSasUri",
+ "fromTime",
+ "toTime"
+ ],
+ "description": "Api input base class for LogAnalytics Api."
+ },
+ "LogAnalyticsOperationResult": {
+ "properties": {
+ "properties": {
+ "readOnly": true,
+ "$ref": "#/definitions/LogAnalyticsOutput",
+ "description": "LogAnalyticsOutput"
+ }
+ },
+ "description": "LogAnalytics operation status response"
+ },
+ "LogAnalyticsOutput": {
+ "properties": {
+ "output": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Output file Uri path to blob container."
+ }
+ },
+ "description": "LogAnalytics output properties"
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/proximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/proximityPlacementGroup.json
new file mode 100644
index 000000000000..78e8f774d12c
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/proximityPlacementGroup.json
@@ -0,0 +1,455 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": {
+ "put": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_CreateOrUpdate",
+ "description": "Create or update a proximity placement group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "proximityPlacementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proximity placement group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ },
+ "description": "Parameters supplied to the Create Proximity Placement Group operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or Update a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_Update",
+ "description": "Update a proximity placement group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "proximityPlacementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proximity placement group."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroupUpdate"
+ },
+ "description": "Parameters supplied to the Update Proximity Placement Group operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_Delete",
+ "description": "Delete a proximity placement group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "proximityPlacementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proximity placement group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_Get",
+ "description": "Retrieves information about a proximity placement group .",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "proximityPlacementGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the proximity placement group."
+ },
+ {
+ "name": "includeColocationStatus",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": {
+ "get": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_ListBySubscription",
+ "description": "Lists all proximity placement groups in a subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Create a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": {
+ "get": {
+ "tags": [
+ "ProximityPlacementGroups"
+ ],
+ "operationId": "ProximityPlacementGroups_ListByResourceGroup",
+ "description": "Lists all proximity placement groups in a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ProximityPlacementGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Create a proximity placement group.": {
+ "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ProximityPlacementGroupProperties": {
+ "properties": {
+ "proximityPlacementGroupType": {
+ "type": "string",
+ "description": "Specifies the type of the proximity placement group.
Possible values are:
**Standard** : Co-locate resources within an Azure region or Availability Zone.
**Ultra** : For future use.",
+ "enum": [
+ "Standard",
+ "Ultra"
+ ],
+ "x-ms-enum": {
+ "name": "ProximityPlacementGroupType",
+ "modelAsString": true
+ }
+ },
+ "virtualMachines": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus"
+ },
+ "description": "A list of references to all virtual machines in the proximity placement group."
+ },
+ "virtualMachineScaleSets": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus"
+ },
+ "description": "A list of references to all virtual machine scale sets in the proximity placement group."
+ },
+ "availabilitySets": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus"
+ },
+ "description": "A list of references to all availability sets in the proximity placement group."
+ },
+ "colocationStatus": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus",
+ "description": "Describes colocation status of the Proximity Placement Group."
+ },
+ "intent": {
+ "type": "object",
+ "properties": {
+ "vmSizes": {
+ "type": "array",
+ "description": "Specifies possible sizes of virtual machines that can be created in the proximity placement group.",
+ "items": {
+ "type": "string",
+ "description": "Specifies the size of the virtual machine. Recommended way to get the list of available sizes is using these APIs:
[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)
[List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list)
[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes).
The available VM sizes depend on region and availability set."
+ }
+ }
+ },
+ "description": "Specifies the user intent of the proximity placement group."
+ }
+ },
+ "description": "Describes the properties of a Proximity Placement Group."
+ },
+ "ProximityPlacementGroup": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/ProximityPlacementGroupProperties",
+ "description": "Describes the properties of a Proximity Placement Group."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Specifies information about the proximity placement group."
+ },
+ "ProximityPlacementGroupUpdate": {
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the proximity placement group."
+ },
+ "ProximityPlacementGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProximityPlacementGroup"
+ },
+ "description": "The list of proximity placement groups"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of proximity placement groups."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Proximity Placement Group operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/restorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/restorePoint.json
new file mode 100644
index 000000000000..5d292786d5ba
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/restorePoint.json
@@ -0,0 +1,899 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}": {
+ "put": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_CreateOrUpdate",
+ "description": "The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.",
+ "x-ms-examples": {
+ "Create or update a restore point collection.": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json"
+ },
+ "Create or update a restore point collection for cross region copy.": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point collection."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollection"
+ },
+ "description": "Parameters supplied to the Create or Update restore point collection operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollection"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_Update",
+ "description": "The operation to update the restore point collection.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point collection."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollectionUpdate"
+ },
+ "description": "Parameters supplied to the Update restore point collection operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RestorePointCollections_Update_MaximumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollections_Update_MaximumSet_Gen.json"
+ },
+ "RestorePointCollections_Update_MinimumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollections_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_Delete",
+ "description": "The operation to delete the restore point collection. This operation will also delete all the contained restore points.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Restore Point Collection."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RestorePointCollections_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollections_Delete_MaximumSet_Gen.json"
+ },
+ "RestorePointCollections_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollections_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_Get",
+ "description": "The operation to get the restore point collection.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point collection."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection.",
+ "enum": [
+ "restorePoints"
+ ],
+ "x-ms-enum": {
+ "name": "RestorePointCollectionExpandOptions",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-examples": {
+ "Get a restore point collection (but not the restore points contained in the restore point collection)": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_Get.json"
+ },
+ "Get a restore point collection, including the restore points contained in the restore point collection": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections": {
+ "get": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_List",
+ "description": "Gets the list of restore point collections in a resource group.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-examples": {
+ "Gets the list of restore point collections in a resource group.": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections": {
+ "get": {
+ "tags": [
+ "RestorePointCollections"
+ ],
+ "operationId": "RestorePointCollections_ListAll",
+ "description": "Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePointCollectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets the list of restore point collections in a subscription": {
+ "$ref": "./examples/restorePointExamples/RestorePointCollection_ListBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}": {
+ "put": {
+ "operationId": "RestorePoints_Create",
+ "description": "The operation to create the restore point. Updating properties of an existing restore point is not allowed",
+ "x-ms-examples": {
+ "Create a restore point": {
+ "$ref": "./examples/restorePointExamples/RestorePoint_Create.json"
+ },
+ "Copy a restore point to a different region": {
+ "$ref": "./examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point collection."
+ },
+ {
+ "name": "restorePointName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestorePoint"
+ },
+ "description": "Parameters supplied to the Create restore point operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/RestorePoint"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "operationId": "RestorePoints_Delete",
+ "description": "The operation to delete the restore point.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the Restore Point Collection."
+ },
+ {
+ "name": "restorePointName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RestorePoints_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePoints_Delete_MaximumSet_Gen.json"
+ },
+ "RestorePoints_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/restorePointExamples/RestorePoints_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "operationId": "RestorePoints_Get",
+ "description": "The operation to get the restore point.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "restorePointCollectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point collection."
+ },
+ {
+ "name": "restorePointName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the restore point."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.",
+ "enum": [
+ "instanceView"
+ ],
+ "x-ms-enum": {
+ "name": "RestorePointExpandOptions",
+ "modelAsString": true
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "x-ms-examples": {
+ "Get a restore point": {
+ "$ref": "./examples/restorePointExamples/RestorePoint_Get.json"
+ },
+ "Get restore point with instance view": {
+ "$ref": "./examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestorePoint"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "RestorePointCollectionSourceProperties": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Location of the source resource used to create this restore point collection."
+ },
+ "id": {
+ "type": "string",
+ "description": "Resource Id of the source resource used to create this restore point collection"
+ }
+ },
+ "description": "The properties of the source resource that this restore point collection is created from."
+ },
+ "RestorePointCollectionProperties": {
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/RestorePointCollectionSourceProperties"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The provisioning state of the restore point collection."
+ },
+ "restorePointCollectionId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The unique id of the restore point collection."
+ },
+ "restorePoints": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/RestorePoint"
+ },
+ "description": "A list containing all restore points created under this restore point collection."
+ }
+ },
+ "description": "The restore point collection properties."
+ },
+ "RestorePointCollection": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RestorePointCollectionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Create or update Restore Point collection parameters."
+ },
+ "RestorePointCollectionUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RestorePointCollectionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Update Restore Point collection parameters."
+ },
+ "RestorePointCollectionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RestorePointCollection"
+ },
+ "description": "Gets the list of restore point collections."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections"
+ }
+ },
+ "description": "The List restore point collection operation response."
+ },
+ "RestorePointSourceMetadata": {
+ "properties": {
+ "hardwareProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/HardwareProfile",
+ "description": "Gets the hardware profile."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/RestorePointSourceVMStorageProfile",
+ "description": "Gets the storage profile."
+ },
+ "osProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/OSProfile",
+ "description": "Gets the OS profile."
+ },
+ "diagnosticsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile",
+ "description": "Gets the diagnostics profile."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "Gets the license type, which is for bring your own license scenario."
+ },
+ "vmId": {
+ "type": "string",
+ "description": "Gets the virtual machine unique id."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/SecurityProfile",
+ "description": "Gets the security profile."
+ },
+ "location": {
+ "type": "string",
+ "description": "Location of the VM from which the restore point was created."
+ },
+ "userData": {
+ "type": "string",
+ "description": "UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value."
+ }
+ },
+ "description": "Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation."
+ },
+ "RestorePointSourceVMStorageProfile": {
+ "properties": {
+ "osDisk": {
+ "$ref": "#/definitions/RestorePointSourceVMOSDisk",
+ "description": "Gets the OS disk of the VM captured at the time of the restore point creation."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RestorePointSourceVMDataDisk"
+ },
+ "x-ms-identifiers": [
+ "lun"
+ ],
+ "description": "Gets the data disks of the VM captured at the time of the restore point creation."
+ }
+ },
+ "description": "Describes the storage profile."
+ },
+ "RestorePointSourceVMOSDisk": {
+ "properties": {
+ "osType": {
+ "type": "string",
+ "description": "Gets the Operating System type.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemType",
+ "modelAsString": true
+ }
+ },
+ "encryptionSettings": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSettings",
+ "description": "Gets the disk encryption settings."
+ },
+ "name": {
+ "type": "string",
+ "description": "Gets the disk name."
+ },
+ "caching": {
+ "$ref": "./computeRPCommon.json#/definitions/Caching",
+ "description": "Gets the caching type."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Gets the disk size in GB."
+ },
+ "managedDisk": {
+ "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters",
+ "description": "Gets the managed disk details"
+ },
+ "diskRestorePoint": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "Gets the disk restore point Id."
+ }
+ },
+ "description": "Describes an Operating System disk."
+ },
+ "RestorePointSourceVMDataDisk": {
+ "properties": {
+ "lun": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Gets the logical unit number."
+ },
+ "name": {
+ "type": "string",
+ "description": "Gets the disk name."
+ },
+ "caching": {
+ "$ref": "./computeRPCommon.json#/definitions/Caching",
+ "description": "Gets the caching type."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks."
+ },
+ "managedDisk": {
+ "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters",
+ "description": "Gets the managed disk details"
+ },
+ "diskRestorePoint": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "Gets the disk restore point Id."
+ }
+ },
+ "description": "Describes a data disk."
+ },
+ "RestorePoint": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RestorePointProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/ProxyResource"
+ }
+ ],
+ "description": "Restore Point details."
+ },
+ "RestorePointInstanceView": {
+ "type": "object",
+ "properties": {
+ "diskRestorePoints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiskRestorePointInstanceView"
+ },
+ "description": "The disk restore points information."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a restore point."
+ },
+ "DiskRestorePointInstanceView": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Disk restore point Id."
+ },
+ "replicationStatus": {
+ "$ref": "#/definitions/DiskRestorePointReplicationStatus",
+ "description": "The disk restore point replication status information."
+ }
+ },
+ "description": "The instance view of a disk restore point."
+ },
+ "DiskRestorePointReplicationStatus": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus",
+ "description": "The resource status information."
+ },
+ "completionPercent": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Replication completion percentage."
+ }
+ },
+ "description": "The instance view of a disk restore point."
+ },
+ "RestorePointProperties": {
+ "type": "object",
+ "properties": {
+ "excludeDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference"
+ },
+ "description": "List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included."
+ },
+ "sourceMetadata": {
+ "readOnly": true,
+ "$ref": "#/definitions/RestorePointSourceMetadata",
+ "description": "Gets the details of the VM captured at the time of the restore point creation."
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Gets the provisioning state of the restore point."
+ },
+ "consistencyMode": {
+ "type": "string",
+ "enum": [
+ "CrashConsistent",
+ "FileSystemConsistent",
+ "ApplicationConsistent"
+ ],
+ "x-ms-enum": {
+ "name": "ConsistencyModeTypes",
+ "modelAsString": true
+ },
+ "description": "ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details."
+ },
+ "timeCreated": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Gets the creation time of the restore point."
+ },
+ "sourceRestorePoint": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "Resource Id of the source restore point from which a copy needs to be created."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/RestorePointInstanceView",
+ "readOnly": true,
+ "description": "The restore point instance view."
+ }
+ },
+ "description": "The restore point properties."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/runCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/runCommand.json
new file mode 100644
index 000000000000..bcbc0f483b21
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/runCommand.json
@@ -0,0 +1,1288 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "RunCommandsClient",
+ "description": "The Run Commands Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json",
+ "text/json"
+ ],
+ "produces": [
+ "application/json",
+ "text/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": {
+ "get": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_List",
+ "x-ms-examples": {
+ "VirtualMachineRunCommandList": {
+ "$ref": "./examples/runCommandExamples/RunCommand_List.json"
+ }
+ },
+ "description": "Lists all available run commands for a subscription in a location.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location upon which run commands is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RunCommandListResult"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": {
+ "get": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_Get",
+ "x-ms-examples": {
+ "VirtualMachineRunCommandGet": {
+ "$ref": "./examples/runCommandExamples/RunCommand_Get.json"
+ }
+ },
+ "description": "Gets specific run command for a subscription in a location.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location upon which run commands is queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "name": "commandId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The command id."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RunCommandDocument"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_RunCommand",
+ "x-ms-examples": {
+ "VirtualMachineRunCommand": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand.json"
+ }
+ },
+ "description": "Run command on the VM.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RunCommandInput"
+ },
+ "description": "Parameters supplied to the Run command operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RunCommandResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_RunCommand",
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_RunCommand": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json"
+ }
+ },
+ "description": "Run command on a virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RunCommandInput"
+ },
+ "description": "Parameters supplied to the Run command operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RunCommandResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_CreateOrUpdate",
+ "description": "The operation to create or update the run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the run command should be created or updated."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "runCommand",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ },
+ "description": "Parameters supplied to the Create Virtual Machine RunCommand operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create or update a run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_Update",
+ "description": "The operation to update the run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the run command should be updated."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "runCommand",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommandUpdate"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine RunCommand operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update a run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_Delete",
+ "description": "The operation to delete the run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the run command should be deleted."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete a run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_GetByVirtualMachine",
+ "description": "The operation to get the run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine containing the run command."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands": {
+ "get": {
+ "tags": [
+ "VirtualMachineRunCommands"
+ ],
+ "operationId": "VirtualMachineRunCommands_ListByVirtualMachine",
+ "description": "The operation to get all run commands of a Virtual Machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine containing the run command."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommandsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List run commands in a Virtual Machine.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_List.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineScaleSetVMRunCommands"
+ ],
+ "operationId": "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate",
+ "description": "The operation to create or update the VMSS VM run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "runCommand",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ },
+ "description": "Parameters supplied to the Create Virtual Machine RunCommand operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create VirtualMachineScaleSet VM run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineScaleSetVMRunCommands"
+ ],
+ "operationId": "VirtualMachineScaleSetVMRunCommands_Update",
+ "description": "The operation to update the VMSS VM run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "runCommand",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommandUpdate"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine RunCommand operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update VirtualMachineScaleSet VM run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineScaleSetVMRunCommands"
+ ],
+ "operationId": "VirtualMachineScaleSetVMRunCommands_Delete",
+ "description": "The operation to delete the VMSS VM run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete VirtualMachineScaleSet VM run command.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMRunCommands"
+ ],
+ "operationId": "VirtualMachineScaleSetVMRunCommands_Get",
+ "description": "The operation to get the VMSS VM run command.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "runCommandName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine run command."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get VirtualMachineScaleSet VM run commands.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMRunCommands"
+ ],
+ "operationId": "VirtualMachineScaleSetVMRunCommands_List",
+ "description": "The operation to get all run commands of an instance in Virtual Machine Scaleset.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineRunCommandsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List run commands in Vmss instance.": {
+ "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "RunCommandInputParameter": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The run command parameter name."
+ },
+ "value": {
+ "type": "string",
+ "description": "The run command parameter value."
+ }
+ },
+ "required": [
+ "name",
+ "value"
+ ],
+ "description": "Describes the properties of a run command parameter."
+ },
+ "RunCommandInput": {
+ "properties": {
+ "commandId": {
+ "type": "string",
+ "description": "The run command id."
+ },
+ "script": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command."
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RunCommandInputParameter"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The run command parameters."
+ }
+ },
+ "required": [
+ "commandId"
+ ],
+ "description": "Capture Virtual Machine parameters."
+ },
+ "RunCommandParameterDefinition": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The run command parameter name."
+ },
+ "type": {
+ "type": "string",
+ "description": "The run command parameter type."
+ },
+ "defaultValue": {
+ "type": "string",
+ "description": "The run command parameter default value."
+ },
+ "required": {
+ "type": "boolean",
+ "description": "The run command parameter required.",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "description": "Describes the properties of a run command parameter."
+ },
+ "RunCommandDocumentBase": {
+ "properties": {
+ "$schema": {
+ "type": "string",
+ "description": "The VM run command schema."
+ },
+ "id": {
+ "type": "string",
+ "description": "The VM run command id."
+ },
+ "osType": {
+ "type": "string",
+ "description": "The Operating System type.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemTypes",
+ "modelAsString": false
+ }
+ },
+ "label": {
+ "type": "string",
+ "description": "The VM run command label."
+ },
+ "description": {
+ "type": "string",
+ "description": "The VM run command description."
+ }
+ },
+ "required": [
+ "$schema",
+ "id",
+ "osType",
+ "label",
+ "description"
+ ],
+ "description": "Describes the properties of a Run Command metadata."
+ },
+ "RunCommandDocument": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RunCommandDocumentBase"
+ }
+ ],
+ "properties": {
+ "script": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The script to be executed."
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RunCommandParameterDefinition"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "description": "The parameters used by the script."
+ }
+ },
+ "required": [
+ "script"
+ ],
+ "description": "Describes the properties of a Run Command."
+ },
+ "RunCommandListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RunCommandDocumentBase"
+ },
+ "description": "The list of virtual machine run commands."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Virtual Machine operation response."
+ },
+ "RunCommandResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "Run command operation response."
+ }
+ }
+ },
+ "VirtualMachineRunCommandInstanceView": {
+ "properties": {
+ "executionState": {
+ "type": "string",
+ "description": "Script execution status.",
+ "enum": [
+ "Unknown",
+ "Pending",
+ "Running",
+ "Failed",
+ "Succeeded",
+ "TimedOut",
+ "Canceled"
+ ],
+ "x-ms-enum": {
+ "name": "ExecutionState",
+ "modelAsString": true
+ }
+ },
+ "executionMessage": {
+ "type": "string",
+ "description": "Communicate script configuration errors or execution messages."
+ },
+ "exitCode": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Exit code returned from script execution."
+ },
+ "output": {
+ "type": "string",
+ "description": "Script output stream."
+ },
+ "error": {
+ "type": "string",
+ "description": "Script error stream."
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Script start time."
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Script end time."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a virtual machine run command."
+ },
+ "VirtualMachineRunCommandScriptSource": {
+ "properties": {
+ "script": {
+ "type": "string",
+ "description": "Specifies the script content to be executed on the VM."
+ },
+ "scriptUri": {
+ "type": "string",
+ "description": "Specifies the script download location."
+ },
+ "commandId": {
+ "type": "string",
+ "description": "Specifies a commandId of predefined built-in script."
+ }
+ },
+ "description": "Describes the script sources for run command."
+ },
+ "VirtualMachineRunCommandProperties": {
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/VirtualMachineRunCommandScriptSource",
+ "description": "The source of the run command script."
+ },
+ "parameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RunCommandInputParameter"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The parameters used by the script."
+ },
+ "protectedParameters": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RunCommandInputParameter"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The parameters used by the script."
+ },
+ "asyncExecution": {
+ "type": "boolean",
+ "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.",
+ "default": false
+ },
+ "runAsUser": {
+ "type": "string",
+ "description": "Specifies the user account on the VM when executing the run command."
+ },
+ "runAsPassword": {
+ "type": "string",
+ "description": "Specifies the user account password on the VM when executing the run command."
+ },
+ "timeoutInSeconds": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The timeout in seconds to execute the run command."
+ },
+ "outputBlobUri": {
+ "type": "string",
+ "description": "Specifies the Azure storage blob where script output stream will be uploaded."
+ },
+ "errorBlobUri": {
+ "type": "string",
+ "description": "Specifies the Azure storage blob where script error stream will be uploaded."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "readOnly": true,
+ "$ref": "#/definitions/VirtualMachineRunCommandInstanceView",
+ "description": "The virtual machine run command instance view."
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine run command."
+ },
+ "VirtualMachineRunCommand": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineRunCommandProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Describes a Virtual Machine run command."
+ },
+ "VirtualMachineRunCommandUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineRunCommandProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Describes a Virtual Machine run command."
+ },
+ "VirtualMachineRunCommandsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineRunCommand"
+ },
+ "description": "The list of run commands"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of run commands."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List run command operation response"
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/sshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/sshPublicKey.json
new file mode 100644
index 000000000000..e895f4855be2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/sshPublicKey.json
@@ -0,0 +1,485 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys": {
+ "get": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_ListBySubscription",
+ "description": "Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeysGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SshPublicKeys_ListBySubscription_MaximumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MaximumSet_Gen.json"
+ },
+ "SshPublicKeys_ListBySubscription_MinimumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_ListBySubscription_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys": {
+ "get": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_ListByResourceGroup",
+ "description": "Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeysGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SshPublicKeys_ListByResourceGroup_MaximumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MaximumSet_Gen.json"
+ },
+ "SshPublicKeys_ListByResourceGroup_MinimumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_ListByResourceGroup_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}": {
+ "put": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_Create",
+ "description": "Creates a new SSH public key resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "sshPublicKeyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SSH public key."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ },
+ "description": "Parameters supplied to create the SSH public key."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a new SSH public key resource.": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Create.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_Update",
+ "description": "Updates a new SSH public key resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "sshPublicKeyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SSH public key."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyUpdateResource"
+ },
+ "description": "Parameters supplied to update the SSH public key."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SshPublicKeys_Update_MaximumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_Update_MaximumSet_Gen.json"
+ },
+ "SshPublicKeys_Update_MinimumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_Delete",
+ "description": "Delete an SSH public key.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "sshPublicKeyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SSH public key."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SshPublicKeys_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_Delete_MaximumSet_Gen.json"
+ },
+ "SshPublicKeys_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_Get",
+ "description": "Retrieves information about an SSH public key.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "sshPublicKeyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SSH public key."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get an ssh public key.": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair": {
+ "post": {
+ "tags": [
+ "SshPublicKeys"
+ ],
+ "operationId": "SshPublicKeys_GenerateKeyPair",
+ "description": "Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "sshPublicKeyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the SSH public key."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SshPublicKeyGenerateKeyPairResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Generate an SSH key pair.": {
+ "$ref": "./examples/sshPublicKeyExamples/SshPublicKeys_GenerateKeyPair.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "SshPublicKeyGenerateKeyPairResult": {
+ "properties": {
+ "privateKey": {
+ "type": "string",
+ "description": "Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret."
+ },
+ "publicKey": {
+ "type": "string",
+ "description": "Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format."
+ },
+ "id": {
+ "type": "string",
+ "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}"
+ }
+ },
+ "required": [
+ "privateKey",
+ "publicKey",
+ "id"
+ ],
+ "description": "Response from generation of an SSH key pair."
+ },
+ "SshPublicKeyResourceProperties": {
+ "properties": {
+ "publicKey": {
+ "type": "string",
+ "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format."
+ }
+ },
+ "description": "Properties of the SSH public key."
+ },
+ "SshPublicKeyResource": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SshPublicKeyResourceProperties",
+ "description": "Properties of the SSH public key."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Specifies information about the SSH public key."
+ },
+ "SshPublicKeyUpdateResource": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/SshPublicKeyResourceProperties",
+ "description": "Properties of the SSH public key."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Specifies information about the SSH public key."
+ },
+ "SshPublicKeysGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SshPublicKeyResource"
+ },
+ "description": "The list of SSH public keys"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The list SSH public keys operation response."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachine.json
new file mode 100644
index 000000000000..04f4e994ab80
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachine.json
@@ -0,0 +1,3370 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineExtensions"
+ ],
+ "operationId": "VirtualMachineExtensions_CreateOrUpdate",
+ "description": "The operation to create or update the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the extension should be created or updated."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ },
+ "description": "Parameters supplied to the Create Virtual Machine Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineExtensions_CreateOrUpdate_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensions_CreateOrUpdate_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_CreateOrUpdate_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineExtensions"
+ ],
+ "operationId": "VirtualMachineExtensions_Update",
+ "description": "The operation to update the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the extension should be updated."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtensionUpdate"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update VM extension.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineExtensions"
+ ],
+ "operationId": "VirtualMachineExtensions_Delete",
+ "description": "The operation to delete the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine where the extension should be deleted."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineExtensions_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensions_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineExtensions"
+ ],
+ "operationId": "VirtualMachineExtensions_Get",
+ "description": "The operation to get the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine containing the extension."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineExtensions_Get_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_Get_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensions_Get_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": {
+ "get": {
+ "tags": [
+ "VirtualMachineExtensions"
+ ],
+ "operationId": "VirtualMachineExtensions_List",
+ "description": "The operation to get all extensions of a Virtual Machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine containing the extension."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtensionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineExtensions_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensions_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachineExtensions_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": {
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_ListByLocation",
+ "description": "Gets all the virtual machines under the specified subscription for the specified location.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location for which virtual machines under the subscription are queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Lists all the virtual machines under the specified subscription for the specified location.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ListBySubscription_ByLocation.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Capture",
+ "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineCaptureParameters"
+ },
+ "description": "Parameters supplied to the Capture Virtual Machine operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineCaptureResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "VirtualMachines_Capture_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Capture_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_Capture_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Capture_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": {
+ "put": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_CreateOrUpdate",
+ "description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachine"
+ },
+ "description": "Parameters supplied to the Create Virtual Machine operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachine"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachine"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create a vm with password authentication.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json"
+ },
+ "Create a vm with ssh authentication.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json"
+ },
+ "Create a vm with premium storage.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json"
+ },
+ "Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json"
+ },
+ "Create a vm in an availability set.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json"
+ },
+ "Create a vm with Scheduled Events Profile": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json"
+ },
+ "Create a vm with boot diagnostics.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json"
+ },
+ "Create a vm with managed boot diagnostics.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json"
+ },
+ "Create a vm with empty data disks.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json"
+ },
+ "Create a vm with a marketplace image plan.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json"
+ },
+ "Create a vm from a custom image.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json"
+ },
+ "Create a platform-image vm with unmanaged os and data disks.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json"
+ },
+ "Create a custom-image vm from an unmanaged generalized os image.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json"
+ },
+ "Create a vm with ephemeral os disk.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json"
+ },
+ "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json"
+ },
+ "Create a vm with ephemeral os disk provisioning in Resource disk using placement property.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json"
+ },
+ "Create a vm with ephemeral os disk provisioning in Cache disk using placement property.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json"
+ },
+ "Create a vm with Host Encryption using encryptionAtHost property.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json"
+ },
+ "Create a Windows vm with a patch setting patchMode of AutomaticByOS.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json"
+ },
+ "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json"
+ },
+ "Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json"
+ },
+ "Create a Windows vm with a patch setting patchMode of Manual.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json"
+ },
+ "Create a Windows vm with a patch setting assessmentMode of ImageDefault.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json"
+ },
+ "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json"
+ },
+ "Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json"
+ },
+ "Create a Linux vm with a patch setting patchMode of ImageDefault.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json"
+ },
+ "Create a Linux vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json"
+ },
+ "Create a Linux vm with a patch setting assessmentMode of ImageDefault.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json"
+ },
+ "Create a vm with an extensions time budget.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json"
+ },
+ "Create a VM with Uefi Settings of secureBoot and vTPM.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json"
+ },
+ "Create a vm from a generalized shared image.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json"
+ },
+ "Create a vm from a specialized shared image.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json"
+ },
+ "Create a VM with network interface configuration": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json"
+ },
+ "Create a VM with UserData": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json"
+ },
+ "Create a vm with Application Profile.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json"
+ },
+ "Create a VM with HibernationEnabled": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json"
+ },
+ "Create a VM with VM Size Properties": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_CreateWithVMSizeProperties.json"
+ },
+ "Create or update a VM with capacity reservation": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json"
+ },
+ "Create a VM from a shared gallery image": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json"
+ },
+ "Create a VM from a community gallery image": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json"
+ },
+ "Create a VM with securityType ConfidentialVM with Platform Managed Keys": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json"
+ },
+ "Create a VM with securityType ConfidentialVM with Customer Managed Keys": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json"
+ },
+ "Create a VM with Disk Controller Type": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Update",
+ "description": "The operation to update a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineUpdate"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachine"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update a VM by detaching data disk": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json"
+ },
+ "Update a VM by force-detaching data disk": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Delete",
+ "description": "The operation to delete a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "forceDeletion",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to force delete virtual machines."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Force delete a VM": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Delete_Force.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Get",
+ "description": "Retrieves information about the model view or the instance view of a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.",
+ "enum": [
+ "instanceView",
+ "userData"
+ ],
+ "x-ms-enum": {
+ "name": "InstanceViewTypes",
+ "modelAsString": false
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachine"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a Virtual Machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get.json"
+ },
+ "Get a virtual machine placed on a dedicated host group through automatic placement": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json"
+ },
+ "Get a virtual machine with VM Size Properties": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json"
+ },
+ "Get a virtual machine with Disk Controller Type Properties": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": {
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_InstanceView",
+ "description": "Retrieves information about the run-time state of a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineInstanceView"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Virtual Machine Instance View.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json"
+ },
+ "Get instance view of a virtual machine placed on a dedicated host group through automatic placement.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_ConvertToManagedDisks",
+ "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_ConvertToManagedDisks_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_ConvertToManagedDisks_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ConvertToManagedDisks_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Deallocate",
+ "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "hibernate",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to hibernate a virtual machine. (Feature in Preview)"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_Deallocate_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Deallocate_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_Deallocate_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Deallocate_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Generalize",
+ "description": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation.
For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource).
For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image).",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Generalize a Virtual Machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Generalize.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": {
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_List",
+ "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachines_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": {
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_ListAll",
+ "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "statusOnly",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachines_ListAll_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ListAll_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_ListAll_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ListAll_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": {
+ "get": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_ListAvailableSizes",
+ "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "Lists all available virtual machine sizes to which the specified virtual machine can be resized": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_ListAvailableVmSizes.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_PowerOff",
+ "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "skipShutdown",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_PowerOff_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_PowerOff_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_PowerOff_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_PowerOff_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Reapply",
+ "description": "The operation to reapply a virtual machine's state.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Reapply the state of a virtual machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reapply.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Restart",
+ "description": "The operation to restart a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_Restart_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Restart_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_Restart_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Restart_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Start",
+ "description": "The operation to start a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_Start_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Start_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_Start_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Start_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Redeploy",
+ "description": "Shuts down the virtual machine, moves it to a new node, and powers it back on.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_Redeploy_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Redeploy_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_Redeploy_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_Redeploy_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_Reimage",
+ "description": "Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineReimageParameters"
+ },
+ "description": "Parameters supplied to the Reimage Virtual Machine operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Reimage a Virtual Machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage.json"
+ },
+ "Reimage a Non-Ephemeral Virtual Machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_RetrieveBootDiagnosticsData",
+ "description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "sasUriExpirationTimeInMinutes",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes.
NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "RetrieveBootDiagnosticsData of a virtual machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_PerformMaintenance",
+ "description": "The operation to perform maintenance on a virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachines_PerformMaintenance_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MaximumSet_Gen.json"
+ },
+ "VirtualMachines_PerformMaintenance_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachines_PerformMaintenance_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_SimulateEviction",
+ "description": "The operation to simulate the eviction of spot virtual machine.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "Simulate Eviction a virtual machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_AssessPatches",
+ "x-ms-examples": {
+ "Assess patch state of a virtual machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_AssessPatches.json"
+ }
+ },
+ "description": "Assess patches on the VM.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineAssessPatchesResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches": {
+ "post": {
+ "tags": [
+ "VirtualMachines"
+ ],
+ "operationId": "VirtualMachines_InstallPatches",
+ "description": "Installs patches on the VM.",
+ "x-ms-examples": {
+ "Install patch state of a virtual machine.": {
+ "$ref": "./examples/virtualMachineExamples/VirtualMachine_InstallPatches.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine."
+ },
+ {
+ "name": "installPatchesInput",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineInstallPatchesParameters"
+ },
+ "description": "Input for InstallPatches as directly received by the API"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineInstallPatchesResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "RetrieveBootDiagnosticsDataResult": {
+ "properties": {
+ "consoleScreenshotBlobUri": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The console screenshot blob URI"
+ },
+ "serialConsoleLogBlobUri": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The serial console log blob URI."
+ }
+ },
+ "description": "The SAS URIs of the console screenshot and serial log blobs."
+ },
+ "VirtualMachineExtensionInstanceView": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The virtual machine extension name."
+ },
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "substatuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of a virtual machine extension."
+ },
+ "VirtualMachineExtensionProperties": {
+ "properties": {
+ "forceUpdateTag": {
+ "type": "string",
+ "description": "How the extension handler should be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "enableAutomaticUpgrade": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
+ },
+ "settings": {
+ "type": "object",
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": "object",
+ "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/VirtualMachineExtensionInstanceView",
+ "description": "The virtual machine extension instance view."
+ },
+ "suppressFailures": {
+ "type": "boolean",
+ "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false."
+ },
+ "protectedSettingsFromKeyVault": {
+ "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference",
+ "description": "The extensions protected settings that are passed by reference, and consumed from key vault"
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Extension."
+ },
+ "VirtualMachineExtensionUpdateProperties": {
+ "properties": {
+ "forceUpdateTag": {
+ "type": "string",
+ "description": "How the extension handler should be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "enableAutomaticUpgrade": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
+ },
+ "settings": {
+ "type": "object",
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": "object",
+ "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
+ },
+ "suppressFailures": {
+ "type": "boolean",
+ "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false."
+ },
+ "protectedSettingsFromKeyVault": {
+ "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference",
+ "description": "The extensions protected settings that are passed by reference, and consumed from key vault"
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Extension."
+ },
+ "VirtualMachineExtension": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineExtensionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ResourceWithOptionalLocation"
+ }
+ ],
+ "description": "Describes a Virtual Machine Extension."
+ },
+ "VirtualMachineExtensionUpdate": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Extension."
+ },
+ "VirtualMachineExtensionsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ },
+ "description": "The list of extensions"
+ }
+ },
+ "description": "The List Extension operation response"
+ },
+ "VirtualMachineSoftwarePatchProperties": {
+ "properties": {
+ "patchId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "A unique identifier for the patch."
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The friendly name of the patch."
+ },
+ "version": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The version number of the patch. This property applies only to Linux patches."
+ },
+ "kbId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The KBID of the patch. Only applies to Windows patches."
+ },
+ "classifications": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "The classification(s) of the patch as provided by the patch publisher."
+ },
+ "rebootBehavior": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Describes the reboot requirements of the patch.",
+ "enum": [
+ "Unknown",
+ "NeverReboots",
+ "AlwaysRequiresReboot",
+ "CanRequestReboot"
+ ],
+ "x-ms-enum": {
+ "name": "VMGuestPatchRebootBehavior",
+ "modelAsString": true
+ }
+ },
+ "activityId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "publishedDate": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the repository published this patch."
+ },
+ "lastModifiedDateTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp of the last update to this patch record."
+ },
+ "assessmentState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Describes the availability of a given patch.",
+ "enum": [
+ "Unknown",
+ "Available"
+ ],
+ "x-ms-enum": {
+ "name": "PatchAssessmentState",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine software patch."
+ },
+ "VirtualMachineAssessPatchesResult": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "CompletedWithWarnings"
+ ],
+ "x-ms-enum": {
+ "name": "PatchOperationStatus",
+ "modelAsString": true
+ }
+ },
+ "assessmentActivityId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootPending": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred."
+ },
+ "criticalAndSecurityPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of critical or security patches that have been detected as available and not yet installed."
+ },
+ "otherPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of all available patches excluding critical and security."
+ },
+ "startDateTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "availablePatches": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineSoftwarePatchProperties"
+ },
+ "x-ms-identifiers": [
+ "patchId"
+ ],
+ "description": "The list of patches that have been detected as available for installation."
+ },
+ "error": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ },
+ "description": "Describes the properties of an AssessPatches result."
+ },
+ "VirtualMachineInstallPatchesParameters": {
+ "properties": {
+ "maximumDuration": {
+ "type": "string",
+ "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)"
+ },
+ "rebootSetting": {
+ "type": "string",
+ "description": "Defines when it is acceptable to reboot a VM during a software update operation.",
+ "enum": [
+ "IfRequired",
+ "Never",
+ "Always"
+ ],
+ "x-ms-enum": {
+ "name": "VMGuestPatchRebootSetting",
+ "modelAsString": true
+ }
+ },
+ "windowsParameters": {
+ "$ref": "#/definitions/WindowsParameters",
+ "description": "Input for InstallPatches on a Windows VM, as directly received by the API"
+ },
+ "linuxParameters": {
+ "$ref": "#/definitions/LinuxParameters",
+ "description": "Input for InstallPatches on a Linux VM, as directly received by the API"
+ }
+ },
+ "required": [
+ "rebootSetting"
+ ],
+ "description": "Input for InstallPatches as directly received by the API"
+ },
+ "WindowsParameters": {
+ "properties": {
+ "classificationsToInclude": {
+ "type": "array",
+ "description": "The update classifications to select when installing patches for Windows.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Critical",
+ "Security",
+ "UpdateRollUp",
+ "FeaturePack",
+ "ServicePack",
+ "Definition",
+ "Tools",
+ "Updates"
+ ],
+ "x-ms-enum": {
+ "name": "VMGuestPatchClassification_Windows",
+ "modelAsString": true
+ }
+ }
+ },
+ "kbNumbersToInclude": {
+ "type": "array",
+ "description": "Kbs to include in the patch operation",
+ "items": {
+ "type": "string"
+ }
+ },
+ "kbNumbersToExclude": {
+ "type": "array",
+ "description": "Kbs to exclude in the patch operation",
+ "items": {
+ "type": "string"
+ }
+ },
+ "excludeKbsRequiringReboot": {
+ "type": "boolean",
+ "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true."
+ },
+ "maxPatchPublishDate": {
+ "type": "string",
+ "format": "date-time",
+ "description": "This is used to install patches that were published on or before this given max published date."
+ }
+ },
+ "description": "Input for InstallPatches on a Windows VM, as directly received by the API"
+ },
+ "LinuxParameters": {
+ "properties": {
+ "classificationsToInclude": {
+ "type": "array",
+ "description": "The update classifications to select when installing patches for Linux.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Critical",
+ "Security",
+ "Other"
+ ],
+ "x-ms-enum": {
+ "name": "VMGuestPatchClassification_Linux",
+ "modelAsString": true
+ }
+ }
+ },
+ "packageNameMasksToInclude": {
+ "type": "array",
+ "description": "packages to include in the patch operation. Format: packageName_packageVersion",
+ "items": {
+ "type": "string"
+ }
+ },
+ "packageNameMasksToExclude": {
+ "type": "array",
+ "description": "packages to exclude in the patch operation. Format: packageName_packageVersion",
+ "items": {
+ "type": "string"
+ }
+ },
+ "maintenanceRunId": {
+ "type": "string",
+ "description": "This is used as a maintenance run identifier for Auto VM Guest Patching in Linux."
+ }
+ },
+ "description": "Input for InstallPatches on a Linux VM, as directly received by the API"
+ },
+ "VirtualMachineInstallPatchesResult": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "CompletedWithWarnings"
+ ],
+ "x-ms-enum": {
+ "name": "PatchOperationStatus",
+ "modelAsString": true
+ }
+ },
+ "installationActivityId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootStatus": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The reboot state of the VM following completion of the operation.",
+ "enum": [
+ "Unknown",
+ "NotNeeded",
+ "Required",
+ "Started",
+ "Failed",
+ "Completed"
+ ],
+ "x-ms-enum": {
+ "name": "VMGuestPatchRebootStatus",
+ "modelAsString": true
+ }
+ },
+ "maintenanceWindowExceeded": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Whether the operation ran out of time before it completed all its intended actions."
+ },
+ "excludedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of patches that were not installed due to the user blocking their installation."
+ },
+ "notSelectedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria."
+ },
+ "pendingPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true."
+ },
+ "installedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of patches successfully installed."
+ },
+ "failedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of patches that could not be installed due to some issue. See errors for details."
+ },
+ "patches": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/PatchInstallationDetail"
+ },
+ "x-ms-identifiers": [
+ "patchId"
+ ],
+ "description": "The patches that were installed during the operation."
+ },
+ "startDateTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ },
+ "description": "The result summary of an installation operation."
+ },
+ "PatchInstallationDetail": {
+ "properties": {
+ "patchId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "A unique identifier for the patch."
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The friendly name of the patch."
+ },
+ "version": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The version string of the package. It may conform to Semantic Versioning. Only applies to Linux."
+ },
+ "kbId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The KBID of the patch. Only applies to Windows patches."
+ },
+ "classifications": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "The classification(s) of the patch as provided by the patch publisher."
+ },
+ "installationState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The state of the patch after the installation operation completed.",
+ "enum": [
+ "Unknown",
+ "Installed",
+ "Failed",
+ "Excluded",
+ "NotSelected",
+ "Pending"
+ ],
+ "x-ms-enum": {
+ "name": "PatchInstallationState",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Information about a specific patch that was encountered during an installation action."
+ },
+ "VirtualMachineReimageParameters": {
+ "properties": {
+ "tempDisk": {
+ "type": "boolean",
+ "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
+ },
+ "exactVersion": {
+ "type": "string",
+ "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk."
+ },
+ "osProfile": {
+ "$ref": "#/definitions/OSProfileProvisioningData",
+ "description": "Specifies information required for reimaging the non-ephemeral OS disk."
+ }
+ },
+ "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged"
+ },
+ "OSProfileProvisioningData": {
+ "type": "object",
+ "properties": {
+ "adminPassword": {
+ "type": "string",
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)",
+ "x-ms-secret": true
+ },
+ "customData": {
+ "type": "string",
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
**Note: Do not pass any secrets or passwords in customData property**
This property cannot be updated after the VM is created.
customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/)
For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)"
+ }
+ },
+ "description": "Additional parameters for Reimaging Non-Ephemeral Virtual Machine."
+ },
+ "VirtualMachineCaptureParameters": {
+ "properties": {
+ "vhdPrefix": {
+ "type": "string",
+ "description": "The captured virtual hard disk's name prefix."
+ },
+ "destinationContainerName": {
+ "type": "string",
+ "description": "The destination container name."
+ },
+ "overwriteVhds": {
+ "type": "boolean",
+ "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict."
+ }
+ },
+ "required": [
+ "vhdPrefix",
+ "destinationContainerName",
+ "overwriteVhds"
+ ],
+ "description": "Capture Virtual Machine parameters."
+ },
+ "VirtualMachineCaptureResult": {
+ "properties": {
+ "$schema": {
+ "readOnly": true,
+ "type": "string",
+ "description": "the schema of the captured virtual machine"
+ },
+ "contentVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "the version of the content"
+ },
+ "parameters": {
+ "readOnly": true,
+ "type": "object",
+ "description": "parameters of the captured virtual machine"
+ },
+ "resources": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "object",
+ "description": "resource item"
+ },
+ "x-ms-identifiers": [],
+ "description": "a list of resource items of the captured virtual machine"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Output of virtual machine capture operation."
+ },
+ "VirtualMachineIpTag": {
+ "properties": {
+ "ipTagType": {
+ "type": "string",
+ "description": "IP tag type. Example: FirstPartyUsage."
+ },
+ "tag": {
+ "type": "string",
+ "description": "IP tag associated with the public IP. Example: SQL, Storage etc."
+ }
+ },
+ "description": "Contains the IP tag associated with the public IP address."
+ },
+ "VirtualMachinePublicIPAddressDnsSettingsConfiguration": {
+ "properties": {
+ "domainNameLabel": {
+ "type": "string",
+ "description": "The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID."
+ }
+ },
+ "required": [
+ "domainNameLabel"
+ ],
+ "description": "Describes a virtual machines network configuration's DNS settings."
+ },
+ "VirtualMachinePublicIPAddressConfigurationProperties": {
+ "properties": {
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The idle timeout of the public IP address."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the public IP address when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachinePublicIPAddressDnsSettingsConfiguration",
+ "description": "The dns settings to be applied on the publicIP addresses ."
+ },
+ "ipTags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineIpTag"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of IP tags associated with the public IP address."
+ },
+ "publicIPPrefix": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The PublicIPPrefix from which to allocate publicIP addresses."
+ },
+ "publicIPAddressVersion": {
+ "type": "string",
+ "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "IPVersions",
+ "modelAsString": true
+ }
+ },
+ "publicIPAllocationMethod": {
+ "type": "string",
+ "description": "Specify the public IP allocation type",
+ "enum": [
+ "Dynamic",
+ "Static"
+ ],
+ "x-ms-enum": {
+ "name": "PublicIPAllocationMethod",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachinePublicIPAddressConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The publicIP address configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachinePublicIPAddressConfigurationProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachineNetworkInterfaceIPConfigurationProperties": {
+ "properties": {
+ "subnet": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies the identifier of the subnet."
+ },
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "publicIPAddressConfiguration": {
+ "$ref": "#/definitions/VirtualMachinePublicIPAddressConfiguration",
+ "description": "The publicIPAddressConfiguration."
+ },
+ "privateIPAddressVersion": {
+ "type": "string",
+ "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "IPVersions",
+ "modelAsString": true
+ }
+ },
+ "applicationSecurityGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to application security group."
+ },
+ "applicationGatewayBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway."
+ },
+ "loadBalancerBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]."
+ }
+ },
+ "description": "Describes a virtual machine network interface IP configuration properties."
+ },
+ "VirtualMachineNetworkInterfaceIPConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The IP configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfigurationProperties"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Describes a virtual machine network profile's IP configuration."
+ },
+ "VirtualMachineNetworkInterfaceDnsSettingsConfiguration": {
+ "properties": {
+ "dnsServers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of DNS servers IP addresses"
+ }
+ },
+ "description": "Describes a virtual machines network configuration's DNS settings."
+ },
+ "VirtualMachineNetworkInterfaceConfigurationProperties": {
+ "properties": {
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the network interface when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ },
+ "enableAcceleratedNetworking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is accelerated networking-enabled."
+ },
+ "disableTcpStateTracking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is disabled for tcp state tracking."
+ },
+ "enableFpga": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is FPGA networking-enabled."
+ },
+ "enableIPForwarding": {
+ "type": "boolean",
+ "description": "Whether IP forwarding enabled on this NIC."
+ },
+ "networkSecurityGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The network security group."
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachineNetworkInterfaceDnsSettingsConfiguration",
+ "description": "The dns settings to be applied on the network interfaces."
+ },
+ "ipConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfiguration"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "Specifies the IP configurations of the network interface."
+ },
+ "dscpConfiguration": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ },
+ "required": [
+ "ipConfigurations"
+ ],
+ "description": "Describes a virtual machine network profile's IP configuration."
+ },
+ "VirtualMachineNetworkInterfaceConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The network interface configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineNetworkInterfaceConfigurationProperties"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Describes a virtual machine network interface configurations."
+ },
+ "VirtualMachineExtensionHandlerInstanceView": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "status": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus",
+ "description": "The extension handler status."
+ }
+ },
+ "description": "The instance view of a virtual machine extension handler."
+ },
+ "VirtualMachineAgentInstanceView": {
+ "properties": {
+ "vmAgentVersion": {
+ "type": "string",
+ "description": "The VM Agent full version."
+ },
+ "extensionHandlers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView"
+ },
+ "x-ms-identifiers": [],
+ "description": "The virtual machine extension handler instance view."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ }
+ },
+ "description": "The instance view of the VM Agent running on the virtual machine."
+ },
+ "VirtualMachineIdentity": {
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities",
+ "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the virtual machine."
+ },
+ "VirtualMachineInstanceView": {
+ "properties": {
+ "platformUpdateDomain": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the update domain of the virtual machine."
+ },
+ "platformFaultDomain": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the fault domain of the virtual machine."
+ },
+ "computerName": {
+ "type": "string",
+ "description": "The computer name assigned to the virtual machine."
+ },
+ "osName": {
+ "type": "string",
+ "description": "The Operating System running on the virtual machine."
+ },
+ "osVersion": {
+ "type": "string",
+ "description": "The version of Operating System running on the virtual machine."
+ },
+ "hyperVGeneration": {
+ "type": "string",
+ "description": "Specifies the HyperVGeneration Type associated with a resource",
+ "enum": [
+ "V1",
+ "V2"
+ ],
+ "x-ms-enum": {
+ "name": "HyperVGenerationType",
+ "modelAsString": true
+ }
+ },
+ "rdpThumbPrint": {
+ "type": "string",
+ "description": "The Remote desktop certificate thumbprint."
+ },
+ "vmAgent": {
+ "$ref": "#/definitions/VirtualMachineAgentInstanceView",
+ "description": "The VM Agent running on the virtual machine."
+ },
+ "maintenanceRedeployStatus": {
+ "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus",
+ "description": "The Maintenance Operation status on the virtual machine."
+ },
+ "disks": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The virtual machine disk information."
+ },
+ "extensions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtensionInstanceView"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "description": "The extensions information."
+ },
+ "vmHealth": {
+ "readOnly": true,
+ "$ref": "#/definitions/VirtualMachineHealthStatus",
+ "description": "The health status for the VM."
+ },
+ "bootDiagnostics": {
+ "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView",
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor."
+ },
+ "assignedHost": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.
Minimum api-version: 2020-06-01."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ },
+ "patchStatus": {
+ "$ref": "#/definitions/VirtualMachinePatchStatus",
+ "description": "[Preview Feature] The status of virtual machine patch operations."
+ }
+ },
+ "description": "The instance view of a virtual machine."
+ },
+ "VirtualMachineProperties": {
+ "properties": {
+ "hardwareProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/HardwareProfile",
+ "description": "Specifies the hardware settings for the virtual machine."
+ },
+ "storageProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/StorageProfile",
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "additionalCapabilities": {
+ "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities",
+ "description": "Specifies additional capabilities enabled or disabled on the virtual machine."
+ },
+ "osProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/OSProfile",
+ "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned."
+ },
+ "networkProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/NetworkProfile",
+ "description": "Specifies the network interfaces of the virtual machine."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/SecurityProfile",
+ "description": "Specifies the Security related profile settings for the virtual machine."
+ },
+ "diagnosticsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile",
+ "description": "Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15."
+ },
+ "availabilitySet": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates)
Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set.
This property cannot exist along with a non-null properties.virtualMachineScaleSet reference."
+ },
+ "virtualMachineScaleSet": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.
This property cannot exist along with a non-null properties.availabilitySet reference.
Minimum api‐version: 2019‐03‐01"
+ },
+ "proximityPlacementGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.
Minimum api-version: 2018-04-01."
+ },
+ "priority": {
+ "$ref": "./computeRPCommon.json#/definitions/priority",
+ "description": "Specifies the priority for the virtual machine.
Minimum api-version: 2019-03-01"
+ },
+ "evictionPolicy": {
+ "$ref": "./computeRPCommon.json#/definitions/evictionPolicy",
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.
For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ },
+ "billingProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/BillingProfile",
+ "description": "Specifies the billing related details of a Azure Spot virtual machine.
Minimum api-version: 2019-03-01."
+ },
+ "host": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the dedicated host that the virtual machine resides in.
Minimum api-version: 2018-10-01."
+ },
+ "hostGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the dedicated host group that the virtual machine resides in.
Minimum api-version: 2020-06-01.
NOTE: User cannot specify both host and hostGroup properties."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/VirtualMachineInstanceView",
+ "readOnly": true,
+ "description": "The virtual machine instance view."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "vmId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands."
+ },
+ "extensionsTimeBudget": {
+ "type": "string",
+ "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).
Minimum api-version: 2020-06-01"
+ },
+ "platformFaultDomain": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains.
This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set.The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' > 1.This property cannot be updated once the Virtual Machine is created.Fault domain assignment can be viewed in the Virtual Machine Instance View.
Minimum api‐version: 2020‐12‐01"
+ },
+ "scheduledEventsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile",
+ "description": "Specifies Scheduled Event related configurations."
+ },
+ "userData": {
+ "type": "string",
+ "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.
Minimum api-version: 2021-03-01"
+ },
+ "capacityReservation": {
+ "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile",
+ "description": "Specifies information about the capacity reservation that is used to allocate virtual machine.
Minimum api-version: 2021-04-01."
+ },
+ "applicationProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile",
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS"
+ },
+ "timeCreated": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the time at which the Virtual Machine resource was created.
Minimum api-version: 2021-11-01."
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine."
+ },
+ "VirtualMachine": {
+ "properties": {
+ "plan": {
+ "$ref": "./computeRPCommon.json#/definitions/Plan",
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineProperties"
+ },
+ "resources": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtension"
+ },
+ "description": "The virtual machine child extension resources."
+ },
+ "identity": {
+ "$ref": "#/definitions/VirtualMachineIdentity",
+ "description": "The identity of the virtual machine, if configured."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine zones."
+ },
+ "extendedLocation": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation",
+ "description": "The extended location of the Virtual Machine."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Describes a Virtual Machine."
+ },
+ "VirtualMachineUpdate": {
+ "properties": {
+ "plan": {
+ "$ref": "./computeRPCommon.json#/definitions/Plan",
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineProperties"
+ },
+ "identity": {
+ "$ref": "#/definitions/VirtualMachineIdentity",
+ "description": "The identity of the virtual machine, if configured."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine zones."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Update."
+ },
+ "VirtualMachineListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachine"
+ },
+ "description": "The list of virtual machines."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Virtual Machine operation response."
+ },
+ "VirtualMachineHealthStatus": {
+ "properties": {
+ "status": {
+ "readOnly": true,
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus",
+ "description": "The health status information for the VM."
+ }
+ },
+ "description": "The health status of the VM."
+ },
+ "VirtualMachinePatchStatus": {
+ "properties": {
+ "availablePatchSummary": {
+ "$ref": "#/definitions/AvailablePatchSummary",
+ "description": "The available patch summary of the latest assessment operation for the virtual machine."
+ },
+ "lastPatchInstallationSummary": {
+ "$ref": "#/definitions/LastPatchInstallationSummary",
+ "description": "The installation summary of the latest installation operation for the virtual machine."
+ },
+ "configurationStatuses": {
+ "description": "The enablement status of the specified patchMode",
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "description": "The status of virtual machine patch operations."
+ },
+ "AvailablePatchSummary": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "CompletedWithWarnings"
+ ],
+ "x-ms-enum": {
+ "name": "PatchOperationStatus",
+ "modelAsString": true
+ }
+ },
+ "assessmentActivityId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "rebootPending": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred."
+ },
+ "criticalAndSecurityPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of critical or security patches that have been detected as available and not yet installed."
+ },
+ "otherPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of all available patches excluding critical and security."
+ },
+ "startTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "lastModifiedTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ },
+ "description": "Describes the properties of an virtual machine instance view for available patch summary."
+ },
+ "LastPatchInstallationSummary": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "CompletedWithWarnings"
+ ],
+ "x-ms-enum": {
+ "name": "PatchOperationStatus",
+ "modelAsString": true
+ }
+ },
+ "installationActivityId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs."
+ },
+ "maintenanceWindowExceeded": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Describes whether the operation ran out of time before it completed all its intended actions"
+ },
+ "notSelectedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry."
+ },
+ "excludedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of all available patches but excluded explicitly by a customer-specified exclusion list match."
+ },
+ "pendingPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The number of all available patches expected to be installed over the course of the patch installation operation."
+ },
+ "installedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The count of patches that successfully installed."
+ },
+ "failedPatchCount": {
+ "type": "integer",
+ "readOnly": true,
+ "format": "int32",
+ "description": "The count of patches that failed installation."
+ },
+ "startTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "lastModifiedTime": {
+ "type": "string",
+ "readOnly": true,
+ "format": "date-time",
+ "description": "The UTC timestamp when the operation began."
+ },
+ "error": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "The errors that were encountered during execution of the operation. The details array contains the list of them."
+ }
+ },
+ "description": "Describes the properties of the last installed patch summary."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineExtensionImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineExtensionImage.json
new file mode 100644
index 000000000000..ac92fe65b7ed
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineExtensionImage.json
@@ -0,0 +1,289 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": {
+ "get": {
+ "tags": [
+ "VirtualMachineExtensionImages"
+ ],
+ "operationId": "VirtualMachineExtensionImages_Get",
+ "description": "Gets a virtual machine extension image.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineExtensionImage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineExtensionImages_Get_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensionImages_Get_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": {
+ "get": {
+ "tags": [
+ "VirtualMachineExtensionImages"
+ ],
+ "operationId": "VirtualMachineExtensionImages_ListTypes",
+ "description": "Gets a list of virtual machine extension image types.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtensionImage"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineExtensionImages_ListTypes_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensionImages_ListTypes_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListTypes_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": {
+ "get": {
+ "tags": [
+ "VirtualMachineExtensionImages"
+ ],
+ "operationId": "VirtualMachineExtensionImages_ListVersions",
+ "description": "Gets a list of virtual machine extension image versions.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "type",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "$orderby",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineExtensionImage"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-odata": "#/definitions/VirtualMachineExtensionImage",
+ "x-ms-examples": {
+ "VirtualMachineExtensionImages_ListVersions_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MaximumSet_Gen.json"
+ },
+ "VirtualMachineExtensionImages_ListVersions_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImages_ListVersions_MinimumSet_Gen.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "VirtualMachineExtensionImageProperties": {
+ "properties": {
+ "operatingSystem": {
+ "type": "string",
+ "description": "The operating system this extension supports."
+ },
+ "computeRole": {
+ "type": "string",
+ "description": "The type of role (IaaS or PaaS) this extension supports."
+ },
+ "handlerSchema": {
+ "type": "string",
+ "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema."
+ },
+ "vmScaleSetEnabled": {
+ "type": "boolean",
+ "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS."
+ },
+ "supportsMultipleExtensions": {
+ "type": "boolean",
+ "description": "Whether the handler can support multiple extensions."
+ }
+ },
+ "required": [
+ "operatingSystem",
+ "computeRole",
+ "handlerSchema"
+ ],
+ "description": "Describes the properties of a Virtual Machine Extension Image."
+ },
+ "VirtualMachineExtensionImage": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineExtensionImageProperties"
+ }
+ },
+ "required": [
+ "name",
+ "location"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Extension Image."
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineImage.json
new file mode 100644
index 000000000000..45a12c2740da
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineImage.json
@@ -0,0 +1,1064 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_Get",
+ "description": "Gets a virtual machine image.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "name": "skus",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU."
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU version."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineImage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImages_Get_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_Get_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImages_Get_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_List",
+ "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "name": "skus",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "$orderby",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImages_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImages_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_ListOffers",
+ "description": "Gets a list of virtual machine image offers for the specified location and publisher.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImages_ListOffers_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImages_ListOffers_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListOffers_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_ListPublishers",
+ "description": "Gets a list of virtual machine image publishers for the specified Azure location.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImages_ListPublishers_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImages_ListPublishers_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListPublishers_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_ListSkus",
+ "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImages_ListSkus_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImages_ListSkus_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImages_ListSkus_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImagesEdgeZone_Get",
+ "description": "Gets a virtual machine image in an edge zone.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "name": "skus",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU."
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU version."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineImage"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImagesEdgeZone_List",
+ "description": "Gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "name": "skus",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image SKU."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "An integer value specifying the number of images to return that matches supplied values."
+ },
+ {
+ "name": "$orderby",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Specifies the order of the results returned. Formatted as an OData query."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImagesEdgeZone_ListOffers",
+ "description": "Gets a list of virtual machine image offers for the specified location, edge zone and publisher.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImagesEdgeZone_ListPublishers",
+ "description": "Gets a list of virtual machine image publishers for the specified Azure location and edge zone.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImages_ListByEdgeZone",
+ "description": "Gets a list of all virtual machine image versions for the specified edge zone",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VmImagesInEdgeZoneListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": {
+ "get": {
+ "tags": [
+ "VirtualMachineImages"
+ ],
+ "operationId": "VirtualMachineImagesEdgeZone_ListSkus",
+ "description": "Gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of a supported Azure region."
+ },
+ {
+ "name": "edgeZone",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the edge zone."
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher."
+ },
+ {
+ "name": "offer",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "A valid image publisher offer."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json"
+ },
+ "VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DisallowedConfiguration": {
+ "properties": {
+ "vmDiskType": {
+ "type": "string",
+ "description": "VM disk types which are disallowed.",
+ "enum": [
+ "None",
+ "Unmanaged"
+ ],
+ "x-ms-enum": {
+ "name": "VmDiskTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies the disallowed configuration for a virtual machine image."
+ },
+ "VirtualMachineImageResource": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "location": {
+ "type": "string",
+ "description": "The supported Azure location of the resource."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)."
+ },
+ "extendedLocation": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation",
+ "description": "The extended location of the Virtual Machine."
+ }
+ },
+ "required": [
+ "name",
+ "location"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Virtual machine image resource information."
+ },
+ "PurchasePlan": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "description": "The publisher ID."
+ },
+ "name": {
+ "type": "string",
+ "description": "The plan ID."
+ },
+ "product": {
+ "type": "string",
+ "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
+ }
+ },
+ "required": [
+ "publisher",
+ "name",
+ "product"
+ ],
+ "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace."
+ },
+ "OSDiskImage": {
+ "properties": {
+ "operatingSystem": {
+ "type": "string",
+ "description": "The operating system of the osDiskImage.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemTypes",
+ "modelAsString": false
+ }
+ }
+ },
+ "required": [
+ "operatingSystem"
+ ],
+ "description": "Contains the os disk image information."
+ },
+ "DataDiskImage": {
+ "properties": {
+ "lun": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ }
+ },
+ "description": "Contains the data disk images information."
+ },
+ "AutomaticOSUpgradeProperties": {
+ "properties": {
+ "automaticOSUpgradeSupported": {
+ "type": "boolean",
+ "description": "Specifies whether automatic OS upgrade is supported on the image."
+ }
+ },
+ "required": [
+ "automaticOSUpgradeSupported"
+ ],
+ "description": "Describes automatic OS upgrade properties on the image."
+ },
+ "ImageDeprecationStatus": {
+ "type": "object",
+ "properties": {
+ "imageState": {
+ "type": "string",
+ "description": "Describes the state of the image.",
+ "enum": [
+ "Active",
+ "ScheduledForDeprecation",
+ "Deprecated"
+ ],
+ "x-ms-enum": {
+ "name": "ImageState",
+ "modelAsString": true
+ }
+ },
+ "scheduledDeprecationTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher."
+ },
+ "alternativeOption": {
+ "$ref": "#/definitions/AlternativeOption"
+ }
+ },
+ "description": "Describes image deprecation status properties on the image."
+ },
+ "AlternativeOption": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Describes the type of the alternative option.",
+ "enum": [
+ "None",
+ "Offer",
+ "Plan"
+ ],
+ "x-ms-enum": {
+ "name": "AlternativeType",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "type": "string",
+ "description": "Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan."
+ }
+ },
+ "description": "Describes the alternative option specified by the Publisher for this image when this image is deprecated."
+ },
+ "VirtualMachineImageFeature": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the feature."
+ },
+ "value": {
+ "type": "string",
+ "description": "The corresponding value for the feature."
+ }
+ },
+ "description": "Specifies additional capabilities supported by the image"
+ },
+ "VirtualMachineImageProperties": {
+ "properties": {
+ "plan": {
+ "$ref": "#/definitions/PurchasePlan"
+ },
+ "osDiskImage": {
+ "$ref": "#/definitions/OSDiskImage"
+ },
+ "dataDiskImages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataDiskImage"
+ },
+ "x-ms-identifiers": [
+ "lun"
+ ]
+ },
+ "automaticOSUpgradeProperties": {
+ "$ref": "#/definitions/AutomaticOSUpgradeProperties"
+ },
+ "hyperVGeneration": {
+ "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType"
+ },
+ "disallowed": {
+ "$ref": "#/definitions/DisallowedConfiguration",
+ "description": "Specifies disallowed configuration for the VirtualMachine created from the image"
+ },
+ "features": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageFeature"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "architecture": {
+ "$ref": "#/definitions/ArchitectureType"
+ },
+ "imageDeprecationStatus": {
+ "$ref": "#/definitions/ImageDeprecationStatus"
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Image."
+ },
+ "VirtualMachineImage": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineImageProperties"
+ }
+ },
+ "required": [
+ "name",
+ "location"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Image."
+ },
+ "VmImagesInEdgeZoneListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineImageResource"
+ },
+ "description": "The list of VMImages in EdgeZone"
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages."
+ }
+ },
+ "description": "The List VmImages in EdgeZone operation response."
+ },
+ "ArchitectureType": {
+ "type": "string",
+ "description": "Specifies the Architecture Type",
+ "enum": [
+ "x64",
+ "Arm64"
+ ],
+ "x-ms-enum": {
+ "name": "ArchitectureTypes",
+ "modelAsString": true
+ }
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineScaleSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineScaleSet.json
new file mode 100644
index 000000000000..227b8c744bb2
--- /dev/null
+++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineScaleSet.json
@@ -0,0 +1,5799 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ComputeManagementClient",
+ "description": "The Compute Management Client.",
+ "version": "2022-11-01"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ListByLocation",
+ "description": "Gets all the VM scale sets under the specified subscription for the specified location.",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The location for which VM scale sets under the subscription are queried.",
+ "pattern": "^[-\\w\\._]+$"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Lists all the VM scale sets under the specified subscription for the specified location.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListBySubscription_ByLocation.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_CreateOrUpdate",
+ "description": "Create or update a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set to create or update."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ },
+ "description": "The scale set object."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create a scale set with password authentication.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json"
+ },
+ "Create a scale set with ssh authentication.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json"
+ },
+ "Create a scale set with premium storage.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json"
+ },
+ "Create a scale set with empty data disks on each vm.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json"
+ },
+ "Create a scale set with an azure load balancer.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json"
+ },
+ "Create a scale set with an azure application gateway.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json"
+ },
+ "Create a scale set with boot diagnostics.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json"
+ },
+ "Create a scale set with managed boot diagnostics.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json"
+ },
+ "Create a scale set with a marketplace image plan.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json"
+ },
+ "Create a scale set from a custom image.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json"
+ },
+ "Create a platform-image scale set with unmanaged os disks.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json"
+ },
+ "Create a custom-image scale set from an unmanaged generalized os image.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json"
+ },
+ "Create a scale set with virtual machines in different zones.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json"
+ },
+ "Create a scale set with ephemeral os disks.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json"
+ },
+ "Create a scale set with terminate scheduled events enabled.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json"
+ },
+ "Create a scale set with OS image scheduled events enabled.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json"
+ },
+ "Create a scale set with automatic repairs enabled": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json"
+ },
+ "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json"
+ },
+ "Create a scale set with ephemeral os disks using placement property.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json"
+ },
+ "Create a scale set with extension time budget.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json"
+ },
+ "Create a scale set with Host Encryption using encryptionAtHost property.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json"
+ },
+ "Create a scale set with Fpga Network Interfaces.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json"
+ },
+ "Create a scale set with Uefi Settings of secureBoot and vTPM.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json"
+ },
+ "Create a scale set from a generalized shared image.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json"
+ },
+ "Create a scale set from a specialized shared image.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json"
+ },
+ "Create a scale set with userData.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json"
+ },
+ "Create a scale set with Application Profile": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json"
+ },
+ "Create a scale set with scaleInPolicy.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json"
+ },
+ "Create a VMSS with an extension that has suppressFailures enabled": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json"
+ },
+ "Create or update a scale set with capacity reservation.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json"
+ },
+ "Create a scale set with spot restore policy": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json"
+ },
+ "Create a scale set with priority mix policy": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json"
+ },
+ "Create a VMSS with an extension with protectedSettingsFromKeyVault": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json"
+ },
+ "Create a scale set with vm size properties": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json"
+ },
+ "Create a scale set with SecurityType as ConfidentialVM": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json"
+ },
+ "Create a scale set with Disk Controller Type": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json"
+ },
+ "Create a scale set where nic config has DisableTcpStateTracking property": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json"
+ },
+ "Create a scale set with Service Artifact Reference": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Update",
+ "description": "Update a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set to create or update."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdate"
+ },
+ "description": "The scale set object."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Update_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Update_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Delete",
+ "description": "Deletes a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "forceDeletion",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to force delete a VM scale set. (Feature in Preview)"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Force Delete a VM scale set.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Get",
+ "description": "Display information about a virtual machine scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation",
+ "enum": [
+ "userData"
+ ],
+ "x-ms-enum": {
+ "name": "ExpandTypesForGetVMScaleSets",
+ "modelAsString": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json"
+ },
+ "Get a virtual machine scale set with UserData": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json"
+ },
+ "Get a virtual machine scale set": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json"
+ },
+ "Get VM scale set VM with Disk Controller Type": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Deallocate",
+ "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Deallocate_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Deallocate_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Deallocate_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_DeleteInstances",
+ "description": "Deletes virtual machines in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "name": "forceDeletion",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_DeleteInstances_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_DeleteInstances_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_DeleteInstances_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_GetInstanceView",
+ "description": "Gets the status of a VM scale set instance.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetInstanceView"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetInstanceView_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_List",
+ "description": "Gets a list of all VM scale sets under a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineScaleSetExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate",
+ "description": "The operation to create or update an extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set where the extension should be create or updated."
+ },
+ {
+ "name": "vmssExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ },
+ "description": "Parameters supplied to the Create VM scale set Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetExtensions_CreateOrUpdate_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetExtensions_CreateOrUpdate_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_CreateOrUpdate_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineScaleSetExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetExtensions_Update",
+ "description": "The operation to update an extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set where the extension should be updated."
+ },
+ {
+ "name": "vmssExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate"
+ },
+ "description": "Parameters supplied to the Update VM scale set Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetExtensions_Update_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetExtensions_Update_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineScaleSetExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetExtensions_Delete",
+ "description": "The operation to delete the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set where the extension should be deleted."
+ },
+ {
+ "name": "vmssExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set extension."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetExtensions_Delete_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetExtensions_Delete_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Delete_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetExtensions_Get",
+ "description": "The operation to get the extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set containing the extension."
+ },
+ {
+ "name": "vmssExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set extension."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSetExtensions_Get_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetExtensions_Get_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_Get_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetExtensions_List",
+ "description": "Gets a list of all extensions in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set containing the extension."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSetExtensions_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetExtensions_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtensions_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ListAll",
+ "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.",
+ "parameters": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_ListAll_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_ListAll_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListAll_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ListSkus",
+ "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_ListSkus_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_ListSkus_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ListSkus_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory",
+ "description": "Gets list of OS upgrades on a VM scale set instance.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_GetOSUpgradeHistory_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_PowerOff",
+ "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "name": "skipShutdown",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_PowerOff_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_PowerOff_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PowerOff_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Restart",
+ "description": "Restarts one or more virtual machines in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Restart_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Restart_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Restart_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Start",
+ "description": "Starts one or more virtual machines in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Start_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Start_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Start_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Redeploy",
+ "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Redeploy_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Redeploy_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Redeploy_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_PerformMaintenance",
+ "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_PerformMaintenance_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_PerformMaintenance_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_PerformMaintenance_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_UpdateInstances",
+ "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_UpdateInstances_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_UpdateInstances_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_UpdateInstances_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_Reimage",
+ "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmScaleSetReimageInput",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters"
+ },
+ "description": "Parameters for Reimaging VM ScaleSet."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_Reimage_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_Reimage_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_Reimage_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ReimageAll",
+ "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "vmInstanceIDs",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
+ },
+ "description": "A list of virtual machine instance IDs from the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_ReimageAll_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_ReimageAll_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ReimageAll_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetRollingUpgrades"
+ ],
+ "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel",
+ "description": "Cancels the current virtual machine scale set rolling upgrade.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetRollingUpgrades_Cancel_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetRollingUpgrades_Cancel_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_Cancel_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetRollingUpgrades"
+ ],
+ "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade",
+ "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetRollingUpgrades"
+ ],
+ "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade",
+ "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Start an extension rolling upgrade.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetRollingUpgrades"
+ ],
+ "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest",
+ "description": "Gets the status of the latest virtual machine scale set rolling upgrade.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RollingUpgradeStatusInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSetRollingUpgrades_GetLatest_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetRollingUpgrades_GetLatest_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrades_GetLatest_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk",
+ "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "platformUpdateDomain",
+ "in": "query",
+ "required": true,
+ "type": "integer",
+ "description": "The platform update domain for which a manual recovery walk is requested"
+ },
+ {
+ "name": "zone",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The zone in which the manual recovery walk is requested for cross zone virtual machine scale set"
+ },
+ {
+ "name": "placementGroupId",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The placement group id for which the manual recovery walk is requested."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecoveryWalkResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup",
+ "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine scale set to create or update."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput"
+ },
+ "description": "The input object for ConvertToSinglePlacementGroup API."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_ConvertToSinglePlacementGroup_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSets"
+ ],
+ "operationId": "VirtualMachineScaleSets_SetOrchestrationServiceState",
+ "description": "Changes ServiceState property for a given service",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine scale set to create or update."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/OrchestrationServiceStateInput"
+ },
+ "description": "The input object for SetOrchestrationServiceState API."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSets_SetOrchestrationServiceState_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSets_SetOrchestrationServiceState_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSets_SetOrchestrationServiceState_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": {
+ "put": {
+ "tags": [
+ "VirtualMachineScaleSetVMExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate",
+ "description": "The operation to create or update the VMSS VM extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ },
+ "description": "Parameters supplied to the Create Virtual Machine Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create VirtualMachineScaleSet VM extension.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Create.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "VirtualMachineScaleSetVMExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetVMExtensions_Update",
+ "description": "The operation to update the VMSS VM extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "extensionParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionUpdate"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine Extension operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update VirtualMachineScaleSet VM extension.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Update.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineScaleSetVMExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetVMExtensions_Delete",
+ "description": "The operation to delete the VMSS VM extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete VirtualMachineScaleSet VM extension.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Delete.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetVMExtensions_Get",
+ "description": "The operation to get the VMSS VM extension.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "vmExtensionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the virtual machine extension."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get VirtualMachineScaleSet VM extension.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMExtensions"
+ ],
+ "operationId": "VirtualMachineScaleSetVMExtensions_List",
+ "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List extensions in Vmss instance.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtensions_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Reimage",
+ "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "vmScaleSetVMReimageInput",
+ "in": "body",
+ "required": false,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters"
+ },
+ "description": "Parameters for the Reimaging Virtual machine in ScaleSet."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Reimage_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Reimage_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Reimage_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_ReimageAll",
+ "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_ReimageAll_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_ReimageAll_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_ReimageAll_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Deallocate",
+ "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Deallocate_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Deallocate_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Deallocate_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}": {
+ "put": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Update",
+ "description": "Updates a virtual machine of a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set where the extension should be create or updated."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVM"
+ },
+ "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVM"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVM"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Update_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Update_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Update_MinimumSet_Gen.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Delete",
+ "description": "Deletes a virtual machine from a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "forceDeletion",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview)"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Force Delete a virtual machine from a VM scale set.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Get",
+ "description": "Gets a virtual machine from a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.",
+ "enum": [
+ "instanceView",
+ "userData"
+ ],
+ "x-ms-enum": {
+ "name": "InstanceViewTypes",
+ "modelAsString": false
+ }
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVM"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get VM scale set VM with UserData": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json"
+ },
+ "Get VM scale set VM with VMSizeProperties": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_GetInstanceView",
+ "description": "Gets the status of a virtual machine from a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": {
+ "get": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_List",
+ "description": "Gets a list of all virtual machines in a VM scale sets.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "virtualMachineScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'."
+ },
+ {
+ "name": "$select",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM",
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_List_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_List_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_List_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_PowerOff",
+ "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "skipShutdown",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_PowerOff_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_PowerOff_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PowerOff_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Restart",
+ "description": "Restarts a virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Restart_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Restart_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Restart_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Start",
+ "description": "Starts a virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Start_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Start_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Start_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_Redeploy",
+ "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_Redeploy_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_Redeploy_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_Redeploy_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData",
+ "description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "name": "sasUriExpirationTimeInMinutes",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes.
NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./virtualMachine.json#/definitions/RetrieveBootDiagnosticsDataResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "RetrieveBootDiagnosticsData of a virtual machine.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance",
+ "description": "Performs maintenance on a virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "VirtualMachineScaleSetVMs_PerformMaintenance_MaximumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MaximumSet_Gen.json"
+ },
+ "VirtualMachineScaleSetVMs_PerformMaintenance_MinimumSet_Gen": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMs_PerformMaintenance_MinimumSet_Gen.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": {
+ "post": {
+ "tags": [
+ "VirtualMachineScaleSetVMs"
+ ],
+ "operationId": "VirtualMachineScaleSetVMs_SimulateEviction",
+ "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ {
+ "name": "vmScaleSetName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the VM scale set."
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The instance ID of the virtual machine."
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "Simulate Eviction a virtual machine.": {
+ "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "VirtualMachineScaleSetVMExtension": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the extension."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ }
+ ],
+ "description": "Describes a VMSS VM Extension."
+ },
+ "VirtualMachineScaleSetVMExtensionUpdate": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the extension."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionUpdateProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ }
+ ],
+ "description": "Describes a VMSS VM Extension."
+ },
+ "VirtualMachineScaleSetVMExtensionsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtension"
+ },
+ "description": "The list of VMSS VM extensions"
+ }
+ },
+ "description": "The List VMSS VM Extension operation response"
+ },
+ "VirtualMachineScaleSetHardwareProfile": {
+ "type": "object",
+ "properties": {
+ "vmSizeProperties": {
+ "$ref": "./computeRPCommon.json#/definitions/VMSizeProperties",
+ "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01.
Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details."
+ }
+ },
+ "description": "Specifies the hardware settings for the virtual machine scale set."
+ },
+ "AutomaticRepairsPolicy": {
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false."
+ },
+ "gracePeriod": {
+ "type": "string",
+ "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)."
+ },
+ "repairAction": {
+ "type": "string",
+ "description": "Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.",
+ "enum": [
+ "Replace",
+ "Restart",
+ "Reimage"
+ ],
+ "x-ms-enum": {
+ "name": "RepairAction",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set."
+ },
+ "AutomaticOSUpgradePolicy": {
+ "properties": {
+ "enableAutomaticOSUpgrade": {
+ "type": "boolean",
+ "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.
If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true."
+ },
+ "disableAutomaticRollback": {
+ "type": "boolean",
+ "description": "Whether OS image rollback feature should be disabled. Default value is false."
+ },
+ "useRollingUpgradePolicy": {
+ "type": "boolean",
+ "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS."
+ }
+ },
+ "description": "The configuration parameters used for performing automatic OS upgrade."
+ },
+ "UpgradePolicy": {
+ "properties": {
+ "mode": {
+ "type": "string",
+ "description": "Specifies the mode of an upgrade to virtual machines in the scale set.
Possible values are:
**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.
**Automatic** - All virtual machines in the scale set are automatically updated at the same time.",
+ "enum": [
+ "Automatic",
+ "Manual",
+ "Rolling"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeMode",
+ "modelAsString": false
+ }
+ },
+ "rollingUpgradePolicy": {
+ "$ref": "#/definitions/RollingUpgradePolicy",
+ "description": "The configuration parameters used while performing a rolling upgrade."
+ },
+ "automaticOSUpgradePolicy": {
+ "$ref": "#/definitions/AutomaticOSUpgradePolicy",
+ "description": "Configuration parameters used for performing automatic OS Upgrade."
+ }
+ },
+ "description": "Describes an upgrade policy - automatic, manual, or rolling."
+ },
+ "RollingUpgradePolicy": {
+ "properties": {
+ "maxBatchInstancePercent": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 5,
+ "maximum": 100,
+ "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%."
+ },
+ "maxUnhealthyInstancePercent": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 5,
+ "maximum": 100,
+ "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%."
+ },
+ "maxUnhealthyUpgradedInstancePercent": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%."
+ },
+ "pauseTimeBetweenBatches": {
+ "type": "string",
+ "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)."
+ },
+ "enableCrossZoneUpgrade": {
+ "type": "boolean",
+ "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size."
+ },
+ "prioritizeUnhealthyInstances": {
+ "type": "boolean",
+ "description": "Upgrade all unhealthy instances in a scale set before any healthy instances."
+ },
+ "rollbackFailedInstancesOnPolicyBreach": {
+ "type": "boolean",
+ "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated."
+ },
+ "maxSurge": {
+ "type": "boolean",
+ "description": "Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch."
+ }
+ },
+ "description": "The configuration parameters used while performing a rolling upgrade."
+ },
+ "ScaleInPolicy": {
+ "properties": {
+ "rules": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Default",
+ "OldestVM",
+ "NewestVM"
+ ],
+ "x-ms-enum": {
+ "name": "VirtualMachineScaleSetScaleInRules",
+ "modelAsString": true
+ }
+ },
+ "description": "The rules to be followed when scaling-in a virtual machine scale set.
Possible values are:
**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.
**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.
**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
"
+ },
+ "forceDeletion": {
+ "type": "boolean",
+ "description": "This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)"
+ }
+ },
+ "description": "Describes a scale-in policy for a virtual machine scale set."
+ },
+ "SpotRestorePolicy": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints"
+ },
+ "restoreTimeout": {
+ "type": "string",
+ "description": "Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances"
+ }
+ },
+ "description": "Specifies the Spot-Try-Restore properties for the virtual machine scale set.
With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint."
+ },
+ "PriorityMixPolicy": {
+ "type": "object",
+ "properties": {
+ "baseRegularPriorityCount": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "description": "The base number of regular priority VMs that will be created in this scale set as it scales out."
+ },
+ "regularPriorityPercentageAboveBase": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 100,
+ "description": "The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority."
+ }
+ },
+ "description": "Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode.
With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached."
+ },
+ "OrchestrationMode": {
+ "type": "string",
+ "description": "Specifies the orchestration mode for the virtual machine scale set.",
+ "enum": [
+ "Uniform",
+ "Flexible"
+ ],
+ "x-ms-enum": {
+ "name": "OrchestrationMode",
+ "modelAsString": true
+ }
+ },
+ "VirtualMachineScaleSetIdentity": {
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities",
+ "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the virtual machine scale set."
+ },
+ "VirtualMachineScaleSetOSProfile": {
+ "properties": {
+ "computerNamePrefix": {
+ "type": "string",
+ "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long."
+ },
+ "adminUsername": {
+ "type": "string",
+ "description": "Specifies the name of the administrator account.
**Windows-only restriction:** Cannot end in \".\"
**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".
**Minimum-length (Linux):** 1 character
**Max-length (Linux):** 64 characters
**Max-length (Windows):** 20 characters"
+ },
+ "adminPassword": {
+ "type": "string",
+ "description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)",
+ "x-ms-secret": true
+ },
+ "customData": {
+ "type": "string",
+ "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)"
+ },
+ "windowsConfiguration": {
+ "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration",
+ "description": "Specifies Windows operating system settings on the virtual machine."
+ },
+ "linuxConfiguration": {
+ "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration",
+ "description": "Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup"
+ },
+ "x-ms-identifiers": [
+ "sourceVault/id"
+ ],
+ "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)."
+ },
+ "allowExtensionOperations": {
+ "type": "boolean",
+ "description": "Specifies whether extension operations should be allowed on the virtual machine scale set.
This may only be set to False when no extensions are present on the virtual machine scale set."
+ },
+ "requireGuestProvisionSignal": {
+ "type": "boolean",
+ "description": "Optional property which must either be set to True or omitted."
+ }
+ },
+ "description": "Describes a virtual machine scale set OS profile."
+ },
+ "VirtualMachineScaleSetUpdateOSProfile": {
+ "properties": {
+ "customData": {
+ "type": "string",
+ "description": "A base-64 encoded string of custom data."
+ },
+ "windowsConfiguration": {
+ "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration",
+ "description": "The Windows Configuration of the OS profile."
+ },
+ "linuxConfiguration": {
+ "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration",
+ "description": "The Linux Configuration of the OS profile."
+ },
+ "secrets": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup"
+ },
+ "x-ms-identifiers": [
+ "sourceVault/id"
+ ],
+ "description": "The List of certificates for addition to the VM."
+ }
+ },
+ "description": "Describes a virtual machine scale set OS profile."
+ },
+ "VirtualMachineScaleSetManagedDiskParameters": {
+ "properties": {
+ "storageAccountType": {
+ "$ref": "./computeRPCommon.json#/definitions/StorageAccountType",
+ "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
+ },
+ "diskEncryptionSet": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters",
+ "description": "Specifies the customer managed disk encryption set resource id for the managed disk."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/VMDiskSecurityProfile",
+ "description": "Specifies the security profile for the managed disk."
+ }
+ },
+ "description": "Describes the parameters of a ScaleSet managed disk."
+ },
+ "VirtualMachineScaleSetOSDisk": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The disk name."
+ },
+ "caching": {
+ "$ref": "./computeRPCommon.json#/definitions/Caching",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None for Standard storage. ReadOnly for Premium storage**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "$ref": "./computeRPCommon.json#/definitions/CreateOption",
+ "description": "Specifies how the virtual machines in the scale set should be created.
The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
+ },
+ "diffDiskSettings": {
+ "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings",
+ "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
+ },
+ "osType": {
+ "type": "string",
+ "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
Possible values are:
**Windows**
**Linux**",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "x-ms-enum": {
+ "name": "OperatingSystemTypes",
+ "modelAsString": false
+ }
+ },
+ "image": {
+ "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk",
+ "description": "Specifies information about the unmanaged user image to base the scale set on."
+ },
+ "vhdContainers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Specifies the container urls that are used to store operating system disks for the scale set."
+ },
+ "managedDisk": {
+ "description": "The managed disk parameters.",
+ "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters"
+ },
+ "deleteOption": {
+ "$ref": "./computeRPCommon.json#/definitions/DeleteOption",
+ "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.
**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.
The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk."
+ }
+ },
+ "required": [
+ "createOption"
+ ],
+ "description": "Describes a virtual machine scale set operating system disk."
+ },
+ "VirtualMachineScaleSetUpdateOSDisk": {
+ "properties": {
+ "caching": {
+ "$ref": "./computeRPCommon.json#/definitions/Caching",
+ "description": "The caching type."
+ },
+ "writeAcceleratorEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
+ },
+ "image": {
+ "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk",
+ "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist."
+ },
+ "vhdContainers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of virtual hard disk container uris."
+ },
+ "managedDisk": {
+ "description": "The managed disk parameters.",
+ "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters"
+ },
+ "deleteOption": {
+ "$ref": "./computeRPCommon.json#/definitions/DeleteOption",
+ "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.
**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.
The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk."
+ }
+ },
+ "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk."
+ },
+ "VirtualMachineScaleSetDataDisk": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The disk name."
+ },
+ "lun": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
+ },
+ "caching": {
+ "$ref": "./computeRPCommon.json#/definitions/Caching",
+ "description": "Specifies the caching requirements.
Possible values are:
**None**
**ReadOnly**
**ReadWrite**
Default: **None for Standard storage. ReadOnly for Premium storage**"
+ },
+ "writeAcceleratorEnabled": {
+ "type": "boolean",
+ "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
+ },
+ "createOption": {
+ "$ref": "./computeRPCommon.json#/definitions/CreateOption",
+ "description": "The create option."
+ },
+ "diskSizeGB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
+ },
+ "managedDisk": {
+ "description": "The managed disk parameters.",
+ "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters"
+ },
+ "diskIOPSReadWrite": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB."
+ },
+ "diskMBpsReadWrite": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB."
+ },
+ "deleteOption": {
+ "$ref": "./computeRPCommon.json#/definitions/DeleteOption",
+ "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).
Possible values:
**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.
**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.
The default value is set to **Delete**."
+ }
+ },
+ "required": [
+ "lun",
+ "createOption"
+ ],
+ "description": "Describes a virtual machine scale set data disk."
+ },
+ "VirtualMachineScaleSetStorageProfile": {
+ "properties": {
+ "imageReference": {
+ "$ref": "./computeRPCommon.json#/definitions/ImageReference",
+ "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations."
+ },
+ "osDisk": {
+ "$ref": "#/definitions/VirtualMachineScaleSetOSDisk",
+ "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetDataDisk"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "lun"
+ ],
+ "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.
For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
+ },
+ "diskControllerType": {
+ "type": "string",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskControllerType",
+ "description": "Specifies the disk controller type configured for the virtual machines in the scale set.
Minimum api-version: 2022-08-01"
+ }
+ }
+ },
+ "description": "Describes a virtual machine scale set storage profile."
+ },
+ "VirtualMachineScaleSetUpdateStorageProfile": {
+ "properties": {
+ "imageReference": {
+ "$ref": "./computeRPCommon.json#/definitions/ImageReference",
+ "description": "The image reference."
+ },
+ "osDisk": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk",
+ "description": "The OS disk."
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetDataDisk"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "lun"
+ ],
+ "description": "The data disks."
+ },
+ "diskControllerType": {
+ "type": "string",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskControllerType",
+ "description": "Specifies the disk controller type configured for the virtual machines in the scale set.
NOTE: You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set.
Minimum api-version: 2022-08-01"
+ }
+ }
+ },
+ "description": "Describes a virtual machine scale set storage profile."
+ },
+ "VirtualMachineScaleSetIPConfigurationProperties": {
+ "properties": {
+ "subnet": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "Specifies the identifier of the subnet."
+ },
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "publicIPAddressConfiguration": {
+ "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration",
+ "description": "The publicIPAddressConfiguration."
+ },
+ "privateIPAddressVersion": {
+ "type": "string",
+ "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "IPVersion",
+ "modelAsString": true
+ }
+ },
+ "applicationGatewayBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway."
+ },
+ "applicationSecurityGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to application security group."
+ },
+ "loadBalancerBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
+ },
+ "loadBalancerInboundNatPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer."
+ }
+ },
+ "description": "Describes a virtual machine scale set network profile's IP configuration properties."
+ },
+ "VirtualMachineScaleSetUpdateIPConfigurationProperties": {
+ "properties": {
+ "subnet": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "The subnet."
+ },
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration."
+ },
+ "publicIPAddressConfiguration": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration",
+ "description": "The publicIPAddressConfiguration."
+ },
+ "privateIPAddressVersion": {
+ "type": "string",
+ "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "IPVersion",
+ "modelAsString": true
+ }
+ },
+ "applicationGatewayBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "The application gateway backend address pools."
+ },
+ "applicationSecurityGroups": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "Specifies an array of references to application security group."
+ },
+ "loadBalancerBackendAddressPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "The load balancer backend address pools."
+ },
+ "loadBalancerInboundNatPools": {
+ "type": "array",
+ "items": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ },
+ "description": "The load balancer inbound nat pools."
+ }
+ },
+ "description": "Describes a virtual machine scale set network profile's IP configuration properties."
+ },
+ "VirtualMachineScaleSetIPConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The IP configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes a virtual machine scale set network profile's IP configuration."
+ },
+ "VirtualMachineScaleSetUpdateIPConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The IP configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network"
+ },
+ "VirtualMachineScaleSetNetworkConfigurationProperties": {
+ "properties": {
+ "primary": {
+ "type": "boolean",
+ "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface."
+ },
+ "enableAcceleratedNetworking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is accelerated networking-enabled."
+ },
+ "disableTcpStateTracking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is disabled for tcp state tracking."
+ },
+ "enableFpga": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is FPGA networking-enabled."
+ },
+ "networkSecurityGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The network security group."
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings",
+ "description": "The dns settings to be applied on the network interfaces."
+ },
+ "ipConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration"
+ },
+ "description": "Specifies the IP configurations of the network interface."
+ },
+ "enableIPForwarding": {
+ "type": "boolean",
+ "description": "Whether IP forwarding enabled on this NIC."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the network interface when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "ipConfigurations"
+ ],
+ "description": "Describes a virtual machine scale set network profile's IP configuration."
+ },
+ "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": {
+ "properties": {
+ "primary": {
+ "type": "boolean",
+ "description": "Whether this is a primary NIC on a virtual machine."
+ },
+ "enableAcceleratedNetworking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is accelerated networking-enabled."
+ },
+ "disableTcpStateTracking": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is disabled for tcp state tracking."
+ },
+ "enableFpga": {
+ "type": "boolean",
+ "description": "Specifies whether the network interface is FPGA networking-enabled."
+ },
+ "networkSecurityGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The network security group."
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings",
+ "description": "The dns settings to be applied on the network interfaces."
+ },
+ "ipConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration"
+ },
+ "description": "The virtual machine scale set IP Configuration."
+ },
+ "enableIPForwarding": {
+ "type": "boolean",
+ "description": "Whether IP forwarding enabled on this NIC."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the network interface when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration."
+ },
+ "VirtualMachineScaleSetNetworkConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The network configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes a virtual machine scale set network profile's network configurations."
+ },
+ "VirtualMachineScaleSetUpdateNetworkConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The network configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
+ }
+ ],
+ "description": "Describes a virtual machine scale set network profile's network configurations."
+ },
+ "VirtualMachineScaleSetNetworkConfigurationDnsSettings": {
+ "properties": {
+ "dnsServers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of DNS servers IP addresses"
+ }
+ },
+ "description": "Describes a virtual machines scale sets network configuration's DNS settings."
+ },
+ "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": {
+ "properties": {
+ "domainNameLabel": {
+ "type": "string",
+ "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created"
+ }
+ },
+ "required": [
+ "domainNameLabel"
+ ],
+ "description": "Describes a virtual machines scale sets network configuration's DNS settings."
+ },
+ "VirtualMachineScaleSetIpTag": {
+ "properties": {
+ "ipTagType": {
+ "type": "string",
+ "description": "IP tag type. Example: FirstPartyUsage."
+ },
+ "tag": {
+ "type": "string",
+ "description": "IP tag associated with the public IP. Example: SQL, Storage etc."
+ }
+ },
+ "description": "Contains the IP tag associated with the public IP address."
+ },
+ "VirtualMachineScaleSetPublicIPAddressConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The publicIP address configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties"
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The publicIP address configuration name."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties"
+ }
+ },
+ "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": {
+ "properties": {
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The idle timeout of the public IP address."
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings",
+ "description": "The dns settings to be applied on the publicIP addresses ."
+ },
+ "ipTags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetIpTag"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of IP tags associated with the public IP address."
+ },
+ "publicIPPrefix": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The PublicIPPrefix from which to allocate publicIP addresses."
+ },
+ "publicIPAddressVersion": {
+ "type": "string",
+ "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "IPVersion",
+ "modelAsString": true
+ }
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the public IP when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": {
+ "properties": {
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The idle timeout of the public IP address."
+ },
+ "dnsSettings": {
+ "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings",
+ "description": "The dns settings to be applied on the publicIP addresses ."
+ },
+ "publicIPPrefix": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "The PublicIPPrefix from which to allocate publicIP addresses."
+ },
+ "deleteOption": {
+ "type": "string",
+ "description": "Specify what happens to the public IP when the VM is deleted",
+ "enum": [
+ "Delete",
+ "Detach"
+ ],
+ "x-ms-enum": {
+ "name": "DeleteOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration"
+ },
+ "VirtualMachineScaleSetNetworkProfile": {
+ "properties": {
+ "healthProbe": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'."
+ },
+ "networkInterfaceConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration"
+ },
+ "description": "The list of network configurations."
+ },
+ "networkApiVersion": {
+ "type": "string",
+ "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'",
+ "enum": [
+ "2020-11-01"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkApiVersion",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machine scale set network profile."
+ },
+ "VirtualMachineScaleSetUpdateNetworkProfile": {
+ "properties": {
+ "healthProbe": {
+ "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference",
+ "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'."
+ },
+ "networkInterfaceConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration"
+ },
+ "description": "The list of network configurations."
+ },
+ "networkApiVersion": {
+ "type": "string",
+ "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'",
+ "enum": [
+ "2020-11-01"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkApiVersion",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Describes a virtual machine scale set network profile."
+ },
+ "VirtualMachineScaleSetExtensionProperties": {
+ "properties": {
+ "forceUpdateTag": {
+ "type": "string",
+ "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The name of the extension handler publisher."
+ },
+ "type": {
+ "type": "string",
+ "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"."
+ },
+ "typeHandlerVersion": {
+ "type": "string",
+ "description": "Specifies the version of the script handler."
+ },
+ "autoUpgradeMinorVersion": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true."
+ },
+ "enableAutomaticUpgrade": {
+ "type": "boolean",
+ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
+ },
+ "settings": {
+ "type": "object",
+ "description": "Json formatted public settings for the extension."
+ },
+ "protectedSettings": {
+ "type": "object",
+ "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "provisionAfterExtensions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Collection of extension names after which this extension needs to be provisioned."
+ },
+ "suppressFailures": {
+ "type": "boolean",
+ "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false."
+ },
+ "protectedSettingsFromKeyVault": {
+ "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference",
+ "description": "The extensions protected settings that are passed by reference, and consumed from key vault"
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Scale Set Extension."
+ },
+ "VirtualMachineScaleSetExtension": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the extension."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set Extension."
+ },
+ "VirtualMachineScaleSetExtensionUpdate": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the extension."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set Extension."
+ },
+ "VirtualMachineScaleSetExtensionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ },
+ "description": "The list of VM scale set extensions."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List VM scale set extension operation response."
+ },
+ "VirtualMachineScaleSetExtensionProfile": {
+ "properties": {
+ "extensions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtension"
+ },
+ "description": "The virtual machine scale set child extension resources."
+ },
+ "extensionsTimeBudget": {
+ "type": "string",
+ "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).
Minimum api-version: 2020-06-01"
+ }
+ },
+ "description": "Describes a virtual machine scale set extension profile."
+ },
+ "VirtualMachineScaleSetVMProfile": {
+ "properties": {
+ "osProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetOSProfile",
+ "description": "Specifies the operating system settings for the virtual machines in the scale set."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile",
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile",
+ "description": "Specifies properties of the network interfaces of the virtual machines in the scale set."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/SecurityProfile",
+ "description": "Specifies the Security related profile settings for the virtual machines in the scale set."
+ },
+ "diagnosticsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile",
+ "description": "Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15."
+ },
+ "extensionProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile",
+ "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "priority": {
+ "$ref": "./computeRPCommon.json#/definitions/priority",
+ "description": "Specifies the priority for the virtual machines in the scale set.
Minimum api-version: 2017-10-30-preview"
+ },
+ "evictionPolicy": {
+ "$ref": "./computeRPCommon.json#/definitions/evictionPolicy",
+ "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.
For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.
For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview."
+ },
+ "billingProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/BillingProfile",
+ "description": "Specifies the billing related details of a Azure Spot VMSS.
Minimum api-version: 2019-03-01."
+ },
+ "scheduledEventsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile",
+ "description": "Specifies Scheduled Event related configurations."
+ },
+ "userData": {
+ "type": "string",
+ "description": "UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here.
Minimum api-version: 2021-03-01"
+ },
+ "capacityReservation": {
+ "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile",
+ "description": "Specifies the capacity reservation related details of a scale set.
Minimum api-version: 2021-04-01."
+ },
+ "applicationProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile",
+ "description": "Specifies the gallery applications that should be made available to the VM/VMSS"
+ },
+ "hardwareProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile",
+ "description": "Specifies the hardware profile related details of a scale set.
Minimum api-version: 2021-11-01."
+ },
+ "serviceArtifactReference": {
+ "$ref": "#/definitions/ServiceArtifactReference",
+ "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01"
+ }
+ },
+ "description": "Describes a virtual machine scale set virtual machine profile."
+ },
+ "VirtualMachineScaleSetUpdateVMProfile": {
+ "properties": {
+ "osProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile",
+ "description": "The virtual machine scale set OS profile."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile",
+ "description": "The virtual machine scale set storage profile."
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile",
+ "description": "The virtual machine scale set network profile."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/SecurityProfile",
+ "description": "The virtual machine scale set Security profile"
+ },
+ "diagnosticsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile",
+ "description": "The virtual machine scale set diagnostics profile."
+ },
+ "extensionProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile",
+ "description": "The virtual machine scale set extension profile."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "The license type, which is for bring your own license scenario."
+ },
+ "billingProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/BillingProfile",
+ "description": "Specifies the billing related details of a Azure Spot VMSS.
Minimum api-version: 2019-03-01."
+ },
+ "scheduledEventsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile",
+ "description": "Specifies Scheduled Event related configurations."
+ },
+ "userData": {
+ "type": "string",
+ "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.
Minimum api-version: 2021-03-01"
+ },
+ "hardwareProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile",
+ "description": "Specifies the hardware profile related details of a scale set.
Minimum api-version: 2021-11-01."
+ }
+ },
+ "description": "Describes a virtual machine scale set virtual machine profile."
+ },
+ "VirtualMachineScaleSetProperties": {
+ "properties": {
+ "upgradePolicy": {
+ "$ref": "#/definitions/UpgradePolicy",
+ "description": "The upgrade policy."
+ },
+ "automaticRepairsPolicy": {
+ "$ref": "#/definitions/AutomaticRepairsPolicy",
+ "description": "Policy for automatic repairs."
+ },
+ "virtualMachineProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMProfile",
+ "description": "The virtual machine profile."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "overprovision": {
+ "type": "boolean",
+ "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned."
+ },
+ "doNotRunExtensionsOnOverprovisionedVMs": {
+ "type": "boolean",
+ "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs."
+ },
+ "uniqueId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set."
+ },
+ "singlePlacementGroup": {
+ "type": "boolean",
+ "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true."
+ },
+ "zoneBalance": {
+ "type": "boolean",
+ "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set."
+ },
+ "platformFaultDomainCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Fault Domain count for each placement group."
+ },
+ "proximityPlacementGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Minimum api-version: 2018-04-01."
+ },
+ "hostGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in.
Minimum api-version: 2020-06-01."
+ },
+ "additionalCapabilities": {
+ "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities",
+ "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type."
+ },
+ "scaleInPolicy": {
+ "$ref": "#/definitions/ScaleInPolicy",
+ "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set."
+ },
+ "orchestrationMode": {
+ "$ref": "#/definitions/OrchestrationMode",
+ "description": "Specifies the orchestration mode for the virtual machine scale set."
+ },
+ "spotRestorePolicy": {
+ "$ref": "#/definitions/SpotRestorePolicy",
+ "description": "Specifies the Spot Restore properties for the virtual machine scale set."
+ },
+ "priorityMixPolicy": {
+ "$ref": "#/definitions/PriorityMixPolicy",
+ "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance."
+ },
+ "timeCreated": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifies the time at which the Virtual Machine Scale Set resource was created.
Minimum api-version: 2021-11-01."
+ },
+ "constrainedMaximumCapacity": {
+ "type": "boolean",
+ "description": "Optional property which must either be set to True or omitted."
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Scale Set."
+ },
+ "VirtualMachineScaleSetUpdateProperties": {
+ "properties": {
+ "upgradePolicy": {
+ "$ref": "#/definitions/UpgradePolicy",
+ "description": "The upgrade policy."
+ },
+ "automaticRepairsPolicy": {
+ "$ref": "#/definitions/AutomaticRepairsPolicy",
+ "description": "Policy for automatic repairs."
+ },
+ "virtualMachineProfile": {
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile",
+ "description": "The virtual machine profile."
+ },
+ "overprovision": {
+ "type": "boolean",
+ "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned."
+ },
+ "doNotRunExtensionsOnOverprovisionedVMs": {
+ "type": "boolean",
+ "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs."
+ },
+ "singlePlacementGroup": {
+ "type": "boolean",
+ "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true."
+ },
+ "additionalCapabilities": {
+ "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities",
+ "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type."
+ },
+ "scaleInPolicy": {
+ "$ref": "#/definitions/ScaleInPolicy",
+ "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set."
+ },
+ "proximityPlacementGroup": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Minimum api-version: 2018-04-01."
+ }
+ },
+ "description": "Describes the properties of a Virtual Machine Scale Set."
+ },
+ "VirtualMachineScaleSet": {
+ "properties": {
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "The virtual machine scale set sku."
+ },
+ "plan": {
+ "$ref": "./computeRPCommon.json#/definitions/Plan",
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetProperties"
+ },
+ "identity": {
+ "$ref": "#/definitions/VirtualMachineScaleSetIdentity",
+ "description": "The identity of the virtual machine scale set, if configured."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set"
+ },
+ "extendedLocation": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation",
+ "description": "The extended location of the Virtual Machine Scale Set."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set."
+ },
+ "VirtualMachineScaleSetVMReimageParameters": {
+ "allOf": [
+ {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineReimageParameters"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters."
+ },
+ "VirtualMachineScaleSetReimageParameters": {
+ "properties": {
+ "instanceIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters."
+ },
+ "VirtualMachineScaleSetUpdate": {
+ "properties": {
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "description": "The virtual machine scale set sku."
+ },
+ "plan": {
+ "$ref": "./computeRPCommon.json#/definitions/Plan",
+ "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties"
+ },
+ "identity": {
+ "$ref": "#/definitions/VirtualMachineScaleSetIdentity",
+ "description": "The identity of the virtual machine scale set, if configured."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "./computeRPCommon.json#/definitions/UpdateResource"
+ }
+ ],
+ "description": "Describes a Virtual Machine Scale Set."
+ },
+ "VirtualMachineScaleSetVMInstanceIDs": {
+ "properties": {
+ "instanceIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set."
+ }
+ },
+ "description": "Specifies a list of virtual machine instance IDs from the VM scale set."
+ },
+ "VirtualMachineScaleSetVMInstanceRequiredIDs": {
+ "properties": {
+ "instanceIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine scale set instance ids."
+ }
+ },
+ "required": [
+ "instanceIds"
+ ],
+ "description": "Specifies a list of virtual machine instance IDs from the VM scale set."
+ },
+ "VirtualMachineStatusCodeCount": {
+ "properties": {
+ "code": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The instance view status code."
+ },
+ "count": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances having a particular status code."
+ }
+ },
+ "description": "The status code and count of the virtual machine scale set instance view status summary."
+ },
+ "VirtualMachineScaleSetInstanceViewStatusesSummary": {
+ "properties": {
+ "statusesSummary": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineStatusCodeCount"
+ },
+ "x-ms-identifiers": [],
+ "description": "The extensions information."
+ }
+ },
+ "description": "Instance view statuses summary for virtual machines of a virtual machine scale set."
+ },
+ "VirtualMachineScaleSetVMExtensionsSummary": {
+ "properties": {
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The extension name."
+ },
+ "statusesSummary": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineStatusCodeCount"
+ },
+ "x-ms-identifiers": [],
+ "description": "The extensions information."
+ }
+ },
+ "description": "Extensions summary for virtual machines of a virtual machine scale set."
+ },
+ "OrchestrationServiceSummary": {
+ "properties": {
+ "serviceName": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the service.",
+ "enum": [
+ "AutomaticRepairs"
+ ],
+ "x-ms-enum": {
+ "name": "OrchestrationServiceNames",
+ "modelAsString": true
+ }
+ },
+ "serviceState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current state of the service.",
+ "enum": [
+ "NotRunning",
+ "Running",
+ "Suspended"
+ ],
+ "x-ms-enum": {
+ "name": "OrchestrationServiceState",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Summary for an orchestration service of a virtual machine scale set."
+ },
+ "VirtualMachineScaleSetInstanceView": {
+ "properties": {
+ "virtualMachine": {
+ "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary",
+ "readOnly": true,
+ "description": "The instance view status summary for the virtual machine scale set."
+ },
+ "extensions": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The extensions information."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ },
+ "orchestrationServices": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OrchestrationServiceSummary"
+ },
+ "x-ms-identifiers": [
+ "serviceName"
+ ],
+ "description": "The orchestration services information."
+ }
+ },
+ "description": "The instance view of a virtual machine scale set."
+ },
+ "VirtualMachineScaleSetListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ },
+ "description": "The list of virtual machine scale sets."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Virtual Machine operation response."
+ },
+ "VirtualMachineScaleSetListWithLinkResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSet"
+ },
+ "description": "The list of virtual machine scale sets."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Virtual Machine operation response."
+ },
+ "VirtualMachineScaleSetSkuCapacity": {
+ "properties": {
+ "minimum": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int64",
+ "description": "The minimum capacity."
+ },
+ "maximum": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum capacity that can be set."
+ },
+ "defaultCapacity": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int64",
+ "description": "The default capacity."
+ },
+ "scaleType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The scale type applicable to the sku.",
+ "enum": [
+ "Automatic",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "VirtualMachineScaleSetSkuScaleType",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Describes scaling information of a sku."
+ },
+ "VirtualMachineScaleSetSku": {
+ "properties": {
+ "resourceType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of resource the sku applies to."
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "readOnly": true,
+ "description": "The Sku."
+ },
+ "capacity": {
+ "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity",
+ "readOnly": true,
+ "description": "Specifies the number of virtual machines in the scale set."
+ }
+ },
+ "description": "Describes an available virtual machine scale set sku."
+ },
+ "VirtualMachineScaleSetListSkusResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetSku"
+ },
+ "x-ms-identifiers": [
+ "resourceType",
+ "sku/name"
+ ],
+ "description": "The list of skus available for the virtual machine scale set."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The Virtual Machine Scale Set List Skus operation response."
+ },
+ "UpgradeOperationHistoryStatus": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Code indicating the current status of the upgrade.",
+ "enum": [
+ "RollingForward",
+ "Cancelled",
+ "Completed",
+ "Faulted"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeState",
+ "modelAsString": false
+ }
+ },
+ "startTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of the upgrade."
+ },
+ "endTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "End time of the upgrade."
+ }
+ },
+ "description": "Information about the current running state of the overall upgrade."
+ },
+ "UpgradeOperationHistoricalStatusInfoProperties": {
+ "properties": {
+ "runningStatus": {
+ "$ref": "#/definitions/UpgradeOperationHistoryStatus",
+ "readOnly": true,
+ "description": "Information about the overall status of the upgrade operation."
+ },
+ "progress": {
+ "$ref": "#/definitions/RollingUpgradeProgressInfo",
+ "readOnly": true,
+ "description": "Counts of the VMs in each state."
+ },
+ "error": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "readOnly": true,
+ "description": "Error Details for this upgrade if there are any."
+ },
+ "startedBy": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Invoker of the Upgrade Operation",
+ "enum": [
+ "Unknown",
+ "User",
+ "Platform"
+ ],
+ "x-ms-enum": {
+ "name": "UpgradeOperationInvoker",
+ "modelAsString": false
+ }
+ },
+ "targetImageReference": {
+ "$ref": "./computeRPCommon.json#/definitions/ImageReference",
+ "readOnly": true,
+ "description": "Image Reference details"
+ },
+ "rollbackInfo": {
+ "$ref": "./computeRPCommon.json#/definitions/RollbackStatusInfo",
+ "readOnly": true,
+ "description": "Information about OS rollback if performed"
+ }
+ },
+ "description": "Describes each OS upgrade on the Virtual Machine Scale Set."
+ },
+ "UpgradeOperationHistoricalStatusInfo": {
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties",
+ "readOnly": true,
+ "description": "Information about the properties of the upgrade operation."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource location"
+ }
+ },
+ "description": "Virtual Machine Scale Set OS Upgrade History operation response."
+ },
+ "VirtualMachineScaleSetListOSUpgradeHistory": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo"
+ },
+ "x-ms-identifiers": [
+ "type",
+ "location"
+ ],
+ "description": "The list of OS upgrades performed on the virtual machine scale set."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "List of Virtual Machine Scale Set OS Upgrade History operation response."
+ },
+ "VirtualMachineScaleSetVMProperties": {
+ "properties": {
+ "latestModelApplied": {
+ "readOnly": true,
+ "type": "boolean",
+ "description": "Specifies whether the latest model has been applied to the virtual machine."
+ },
+ "vmId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Azure VM unique ID."
+ },
+ "instanceView": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView",
+ "readOnly": true,
+ "description": "The virtual machine instance view."
+ },
+ "hardwareProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/HardwareProfile",
+ "description": "Specifies the hardware settings for the virtual machine."
+ },
+ "storageProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/StorageProfile",
+ "description": "Specifies the storage settings for the virtual machine disks."
+ },
+ "additionalCapabilities": {
+ "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities",
+ "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type."
+ },
+ "osProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/OSProfile",
+ "description": "Specifies the operating system settings for the virtual machine."
+ },
+ "securityProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/SecurityProfile",
+ "description": "Specifies the Security related profile settings for the virtual machine."
+ },
+ "networkProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/NetworkProfile",
+ "description": "Specifies the network interfaces of the virtual machine."
+ },
+ "networkProfileConfiguration": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration",
+ "description": "Specifies the network profile configuration of the virtual machine."
+ },
+ "diagnosticsProfile": {
+ "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile",
+ "description": "Specifies the boot diagnostic settings state.
Minimum api-version: 2015-06-15."
+ },
+ "availabilitySet": {
+ "$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
+ "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview).
For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates)
Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state, which only appears in the response."
+ },
+ "licenseType": {
+ "type": "string",
+ "description": "Specifies that the image or disk that is being used was licensed on-premises.
Possible values for Windows Server operating system are:
Windows_Client
Windows_Server
Possible values for Linux Server operating system are:
RHEL_BYOS (for RHEL)
SLES_BYOS (for SUSE)
For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)
[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)
Minimum api-version: 2015-06-15"
+ },
+ "modelDefinitionApplied": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine."
+ },
+ "protectionPolicy": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy",
+ "description": "Specifies the protection policy of the virtual machine."
+ },
+ "userData": {
+ "type": "string",
+ "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.
Minimum api-version: 2021-03-01"
+ }
+ },
+ "description": "Describes the properties of a virtual machine scale set virtual machine."
+ },
+ "VirtualMachineScaleSetVM": {
+ "properties": {
+ "instanceId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The virtual machine instance ID."
+ },
+ "sku": {
+ "$ref": "./computeRPCommon.json#/definitions/Sku",
+ "readOnly": true,
+ "description": "The virtual machine SKU."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualMachineScaleSetVMProperties"
+ },
+ "plan": {
+ "$ref": "./computeRPCommon.json#/definitions/Plan",
+ "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
+ },
+ "resources": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension"
+ },
+ "description": "The virtual machine child extension resources."
+ },
+ "zones": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The virtual machine zones."
+ },
+ "identity": {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineIdentity",
+ "description": "The identity of the virtual machine, if configured."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "Describes a virtual machine scale set virtual machine."
+ },
+ "VirtualMachineScaleSetVMInstanceView": {
+ "properties": {
+ "platformUpdateDomain": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The Update Domain count."
+ },
+ "platformFaultDomain": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The Fault Domain count."
+ },
+ "rdpThumbPrint": {
+ "type": "string",
+ "description": "The Remote desktop certificate thumbprint."
+ },
+ "vmAgent": {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineAgentInstanceView",
+ "description": "The VM Agent running on the virtual machine."
+ },
+ "maintenanceRedeployStatus": {
+ "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus",
+ "description": "The Maintenance Operation status on the virtual machine."
+ },
+ "disks": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "The disks information."
+ },
+ "extensions": {
+ "type": "array",
+ "items": {
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionInstanceView"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "description": "The extensions information."
+ },
+ "vmHealth": {
+ "readOnly": true,
+ "$ref": "./virtualMachine.json#/definitions/VirtualMachineHealthStatus",
+ "description": "The health status for the VM."
+ },
+ "bootDiagnostics": {
+ "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView",
+ "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.
You can easily view the output of your console log.
Azure also enables you to see a screenshot of the VM from the hypervisor."
+ },
+ "statuses": {
+ "type": "array",
+ "items": {
+ "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus"
+ },
+ "x-ms-identifiers": [],
+ "description": "The resource status information."
+ },
+ "assignedHost": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.
Minimum api-version: 2020-06-01."
+ },
+ "placementGroupId": {
+ "type": "string",
+ "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId."
+ }
+ },
+ "description": "The instance view of a virtual machine scale set VM."
+ },
+ "VirtualMachineScaleSetVMNetworkProfileConfiguration": {
+ "properties": {
+ "networkInterfaceConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration"
+ },
+ "description": "The list of network configurations."
+ }
+ },
+ "description": "Describes a virtual machine scale set VM network profile."
+ },
+ "VirtualMachineScaleSetVMProtectionPolicy": {
+ "properties": {
+ "protectFromScaleIn": {
+ "type": "boolean",
+ "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation."
+ },
+ "protectFromScaleSetActions": {
+ "type": "boolean",
+ "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM."
+ }
+ },
+ "description": "The protection policy of a virtual machine scale set VM."
+ },
+ "VirtualMachineScaleSetVMListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualMachineScaleSetVM"
+ },
+ "description": "The list of virtual machine scale sets VMs."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The List Virtual Machine Scale Set VMs operation response."
+ },
+ "RollingUpgradeStatusInfo": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/RollingUpgradeStatusInfoProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../common-types/v1/common.json#/definitions/Resource"
+ }
+ ],
+ "description": "The status of the latest virtual machine scale set rolling upgrade."
+ },
+ "RollingUpgradeStatusInfoProperties": {
+ "properties": {
+ "policy": {
+ "readOnly": true,
+ "$ref": "#/definitions/RollingUpgradePolicy",
+ "description": "The rolling upgrade policies applied for this upgrade."
+ },
+ "runningStatus": {
+ "readOnly": true,
+ "$ref": "#/definitions/RollingUpgradeRunningStatus",
+ "description": "Information about the current running state of the overall upgrade."
+ },
+ "progress": {
+ "readOnly": true,
+ "$ref": "#/definitions/RollingUpgradeProgressInfo",
+ "description": "Information about the number of virtual machine instances in each upgrade state."
+ },
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../common-types/v1/common.json#/definitions/ApiError",
+ "description": "Error details for this upgrade, if there are any."
+ }
+ },
+ "description": "The status of the latest virtual machine scale set rolling upgrade."
+ },
+ "RollingUpgradeRunningStatus": {
+ "properties": {
+ "code": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Code indicating the current status of the upgrade.",
+ "enum": [
+ "RollingForward",
+ "Cancelled",
+ "Completed",
+ "Faulted"
+ ],
+ "x-ms-enum": {
+ "name": "RollingUpgradeStatusCode",
+ "modelAsString": false
+ }
+ },
+ "startTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of the upgrade."
+ },
+ "lastAction": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The last action performed on the rolling upgrade.",
+ "enum": [
+ "Start",
+ "Cancel"
+ ],
+ "x-ms-enum": {
+ "name": "RollingUpgradeActionType",
+ "modelAsString": false
+ }
+ },
+ "lastActionTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Last action time of the upgrade."
+ }
+ },
+ "description": "Information about the current running state of the overall upgrade."
+ },
+ "RollingUpgradeProgressInfo": {
+ "properties": {
+ "successfulInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances that have been successfully upgraded."
+ },
+ "failedInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances that have failed to be upgraded successfully."
+ },
+ "inProgressInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances that are currently being upgraded."
+ },
+ "pendingInstanceCount": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of instances that have not yet begun to be upgraded."
+ }
+ },
+ "description": "Information about the number of virtual machine instances in each upgrade state."
+ },
+ "RecoveryWalkResponse": {
+ "properties": {
+ "walkPerformed": {
+ "type": "boolean",
+ "readOnly": true,
+ "description": "Whether the recovery walk was performed"
+ },
+ "nextPlatformUpdateDomain": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed"
+ }
+ },
+ "description": "Response after calling a manual recovery walk"
+ },
+ "VMScaleSetConvertToSinglePlacementGroupInput": {
+ "properties": {
+ "activePlacementGroupId": {
+ "type": "string",
+ "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances."
+ }
+ }
+ },
+ "OrchestrationServiceStateInput": {
+ "properties": {
+ "serviceName": {
+ "type": "string",
+ "description": "The name of the service.",
+ "enum": [
+ "AutomaticRepairs"
+ ],
+ "x-ms-enum": {
+ "name": "OrchestrationServiceNames",
+ "modelAsString": true
+ }
+ },
+ "action": {
+ "type": "string",
+ "description": "The action to be performed.",
+ "enum": [
+ "Resume",
+ "Suspend"
+ ],
+ "x-ms-enum": {
+ "name": "OrchestrationServiceStateAction",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "The input for OrchestrationServiceState",
+ "required": [
+ "serviceName",
+ "action"
+ ]
+ },
+ "ServiceArtifactReference": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}"
+ }
+ },
+ "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01"
+ }
+ }
+}
diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2021-10-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2021-10-01/gallery.json
index 1d6277e7790c..9129b7c1f0e7 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2021-10-01/gallery.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2021-10-01/gallery.json
@@ -2565,6 +2565,7 @@
"enum": [
"Standard_LRS",
"Standard_ZRS",
+ "StandardSSD_LRS",
"Premium_LRS"
],
"x-ms-enum": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-01-03/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-01-03/gallery.json
index adc6697f6c36..52d730ba4688 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-01-03/gallery.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-01-03/gallery.json
@@ -2450,6 +2450,7 @@
"enum": [
"Standard_LRS",
"Standard_ZRS",
+ "StandardSSD_LRS",
"Premium_LRS"
],
"x-ms-enum": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
index 12e3b623fe02..f05f92e685da 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
@@ -2563,6 +2563,7 @@
"enum": [
"Standard_LRS",
"Standard_ZRS",
+ "StandardSSD_LRS",
"Premium_LRS"
],
"x-ms-enum": {
diff --git a/specification/compute/resource-manager/Microsoft.Compute/common-types/v1/common.json b/specification/compute/resource-manager/Microsoft.Compute/common-types/v1/common.json
index 2d8c8fb0670a..abc634fb7320 100644
--- a/specification/compute/resource-manager/Microsoft.Compute/common-types/v1/common.json
+++ b/specification/compute/resource-manager/Microsoft.Compute/common-types/v1/common.json
@@ -236,6 +236,24 @@
}
},
"description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ },
+ "SystemData": {
+ "description": "The system meta data relating to this resource.",
+ "type": "object",
+ "properties": {
+ "createdAt": {
+ "format": "date-time",
+ "description": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedAt": {
+ "format": "date-time",
+ "description": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
}
},
"parameters": {
diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md
index 4947aac8a702..5f255cfc4688 100644
--- a/specification/compute/resource-manager/readme.md
+++ b/specification/compute/resource-manager/readme.md
@@ -34,7 +34,7 @@ These are the global settings for the Compute API.
title: ComputeManagementClient
description: Compute Client
openapi-type: arm
-tag: package-2022-03-03
+tag: package-2022-11-01
directive:
- where:
@@ -233,6 +233,113 @@ directive:
- $.definitions.SubResourceWithColocationStatus
suppress:
- RequiredPropertiesMissingInResourceModel
+ - suppress:
+ - APIVersionPattern
+ from:
+ - Microsoft.Compute/common-types/v1/common.json
+```
+
+### Tag: package-2022-11-01
+
+These settings apply only when `--tag=package-2022-11-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-11-01'
+input-file:
+ - Microsoft.Compute/common-types/v1/common.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/computeRPCommon.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineScaleSet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachine.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineExtensionImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/availabilitySet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/proximityPlacementGroup.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/dedicatedHost.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/sshPublicKey.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/image.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/restorePoint.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/capacityReservation.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/logAnalytic.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/runCommand.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskRPCommon.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/disk.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskAccess.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskEncryptionSet.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskRestorePoint.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/snapshot.json
+ - Microsoft.Compute/Skus/stable/2021-07-01/skus.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/galleryRPCommon.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/sharedGallery.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/communityGallery.json
+ - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json
+```
+
+### Tag: package-2022-11-01-only
+
+These settings apply only when `--tag=package-2022-11-01-only` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-11-01-only'
+input-file:
+ - Microsoft.Compute/common-types/v1/common.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/computeRPCommon.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineScaleSet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachine.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/virtualMachineExtensionImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/availabilitySet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/proximityPlacementGroup.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/dedicatedHost.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/sshPublicKey.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/image.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/restorePoint.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/capacityReservation.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/logAnalytic.json
+ - Microsoft.Compute/ComputeRP/stable/2022-11-01/runCommand.json
+```
+
+### Tag: package-2022-09-04
+
+These settings apply only when `--tag=package-2022-09-04` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-09-04'
+input-file:
+ - Microsoft.Compute/common-types/v1/common.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/computeRPCommon.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/virtualMachineScaleSet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/virtualMachine.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/virtualMachineImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/virtualMachineExtensionImage.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/availabilitySet.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/proximityPlacementGroup.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/dedicatedHost.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/sshPublicKey.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/image.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/restorePoint.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/capacityReservation.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/logAnalytic.json
+ - Microsoft.Compute/ComputeRP/stable/2022-08-01/runCommand.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskRPCommon.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/disk.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskAccess.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskEncryptionSet.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/diskRestorePoint.json
+ - Microsoft.Compute/DiskRP/stable/2022-07-02/snapshot.json
+ - Microsoft.Compute/Skus/stable/2021-07-01/skus.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/galleryRPCommon.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/sharedGallery.json
+ - Microsoft.Compute/GalleryRP/stable/2022-03-03/communityGallery.json
+ - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json
+```
+
+### Tag: package-2022-09-04-only
+
+These settings apply only when `--tag=package-2022-09-04-only` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-09-04-only'
+input-file:
+ - Microsoft.Compute/common-types/v1/common.json
+ - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json
```
### Tag: package-2022-03-03
@@ -276,6 +383,7 @@ These settings apply only when `--tag=package-2022-03-03-only` is specified on t
```yaml $(tag) == 'package-2022-03-03-only'
input-file:
+ - Microsoft.Compute/common-types/v1/common.json
- Microsoft.Compute/GalleryRP/stable/2022-03-03/galleryRPCommon.json
- Microsoft.Compute/GalleryRP/stable/2022-03-03/gallery.json
- Microsoft.Compute/GalleryRP/stable/2022-03-03/sharedGallery.json
diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md
index cb73285aa937..eb53881a0be8 100644
--- a/specification/compute/resource-manager/readme.python.md
+++ b/specification/compute/resource-manager/readme.python.md
@@ -37,6 +37,8 @@ Generate all API versions currently shipped for this package
multiapi: true
clear-output-folder: true
batch:
+ - tag: package-2022-11-01-only
+ - tag: package-2022-09-04-only
- tag: package-2022-08-01-only
- tag: package-2022-07-02-only
- tag: package-2022-04-04-only
@@ -80,6 +82,26 @@ output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compu
perform-load: false
```
+### Tag: package-2022-11-01-only
+
+These settings apply only when `--tag=package-2022-11-01-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-11-01-only'
+namespace: azure.mgmt.compute.v2022_11_01
+output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2022_11_01
+```
+
+### Tag: package-2022-09-04-only
+
+These settings apply only when `--tag=package-2022-09-04-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-09-04-only'
+namespace: azure.mgmt.compute.v2022_09_04
+output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2022_09_04
+```
+
### Tag: package-2022-08-01-only
These settings apply only when `--tag=package-2022-08-01-only --python` is specified on the command line.
diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/consumption.json
index cb734f6071aa..ec5ded0d0fd7 100644
--- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/consumption.json
+++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/consumption.json
@@ -883,7 +883,7 @@
"ReservationDetails"
],
"operationId": "ReservationsDetails_ListByReservationOrder",
- "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
+ "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
@@ -932,7 +932,7 @@
"ReservationDetails"
],
"operationId": "ReservationsDetails_ListByReservationOrderAndReservation",
- "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
+ "description": "Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
@@ -984,7 +984,7 @@
"ReservationDetails"
],
"operationId": "ReservationsDetails_List",
- "description": "Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
+ "description": "Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/consumption/"
},
@@ -4711,7 +4711,7 @@
"discriminator": "kind",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "#/definitions/ProxyResource"
}
],
"properties": {
@@ -4874,6 +4874,11 @@
"description": "Is charge Invoiced",
"type": "boolean",
"readOnly": true
+ },
+ "subscriptionId": {
+ "description": "Subscription guid.",
+ "type": "string",
+ "readOnly": true
}
}
},
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
new file mode 100644
index 000000000000..b9650dfe88c8
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
@@ -0,0 +1,7292 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2023-01-01-preview",
+ "title": "ContainerRegistryManagementClient"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules": {
+ "get": {
+ "tags": [
+ "CacheRules"
+ ],
+ "description": "Lists all cache rule resources for the specified container registry.",
+ "operationId": "CacheRules_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CacheRulesListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CacheRuleList": {
+ "$ref": "./examples/CacheRuleList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}": {
+ "get": {
+ "tags": [
+ "CacheRules"
+ ],
+ "description": "Gets the properties of the specified cache rule resource.",
+ "operationId": "CacheRules_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CacheRuleNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CacheRuleGet": {
+ "$ref": "./examples/CacheRuleGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "CacheRules"
+ ],
+ "description": "Creates a cache rule for a container registry with the specified parameters.",
+ "operationId": "CacheRules_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CacheRuleNameParameter"
+ },
+ {
+ "name": "cacheRuleCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a cache rule.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CacheRuleCreate": {
+ "$ref": "./examples/CacheRuleCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "CacheRules"
+ ],
+ "description": "Deletes a cache rule resource from a container registry.",
+ "operationId": "CacheRules_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CacheRuleNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The cache rule does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CacheRuleDelete": {
+ "$ref": "./examples/CacheRuleDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "CacheRules"
+ ],
+ "description": "Updates a cache rule for a container registry with the specified parameters.",
+ "operationId": "CacheRules_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CacheRuleNameParameter"
+ },
+ {
+ "name": "cacheRuleUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a cache rule.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CacheRuleUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CacheRule"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CacheRuleUpdate": {
+ "$ref": "./examples/CacheRuleUpdate.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.ContainerRegistry/registries/{registryName}/connectedRegistries": {
+ "get": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Lists all connected registries for the specified container registry.",
+ "operationId": "ConnectedRegistries_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryFilterParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistryListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryList": {
+ "$ref": "./examples/ConnectedRegistryList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}": {
+ "get": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Gets the properties of the connected registry.",
+ "operationId": "ConnectedRegistries_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryGet": {
+ "$ref": "./examples/ConnectedRegistryGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Creates a connected registry for a container registry with the specified parameters.",
+ "operationId": "ConnectedRegistries_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryNameParameter"
+ },
+ {
+ "name": "connectedRegistryCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a connectedRegistry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryCreate": {
+ "$ref": "./examples/ConnectedRegistryCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Deletes a connected registry from a container registry.",
+ "operationId": "ConnectedRegistries_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The webhook does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryDelete": {
+ "$ref": "./examples/ConnectedRegistryDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Updates a connected registry with the specified parameters.",
+ "operationId": "ConnectedRegistries_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryNameParameter"
+ },
+ {
+ "name": "connectedRegistryUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a connectedRegistry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistryUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryUpdate": {
+ "$ref": "./examples/ConnectedRegistryUpdate.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.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate": {
+ "post": {
+ "tags": [
+ "ConnectedRegistries"
+ ],
+ "description": "Deactivates the connected registry instance.",
+ "operationId": "ConnectedRegistries_Deactivate",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ConnectedRegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ConnectedRegistryDeactivate": {
+ "$ref": "./examples/ConnectedRegistryDeactivate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets": {
+ "get": {
+ "tags": [
+ "CredentialSets"
+ ],
+ "description": "Lists all credential set resources for the specified container registry.",
+ "operationId": "CredentialSets_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSetListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CredentialSetList": {
+ "$ref": "./examples/CredentialSetList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}": {
+ "get": {
+ "tags": [
+ "CredentialSets"
+ ],
+ "description": "Gets the properties of the specified credential set resource.",
+ "operationId": "CredentialSets_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CredentialSetNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CredentialSetGet": {
+ "$ref": "./examples/CredentialSetGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "CredentialSets"
+ ],
+ "description": "Creates a credential set for a container registry with the specified parameters.",
+ "operationId": "CredentialSets_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CredentialSetNameParameter"
+ },
+ {
+ "name": "credentialSetCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a credential set.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CredentialSetCreate": {
+ "$ref": "./examples/CredentialSetCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "CredentialSets"
+ ],
+ "description": "Deletes a credential set from a container registry.",
+ "operationId": "CredentialSets_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CredentialSetNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The credential store resource does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CredentialSetDelete": {
+ "$ref": "./examples/CredentialSetDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "CredentialSets"
+ ],
+ "description": "Updates a credential set for a container registry with the specified parameters.",
+ "operationId": "CredentialSets_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/CredentialSetNameParameter"
+ },
+ {
+ "name": "credentialSetUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a credential set.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CredentialSetUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/CredentialSet"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CredentialSetUpdate": {
+ "$ref": "./examples/CredentialSetUpdate.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.ContainerRegistry/registries/{registryName}/exportPipelines": {
+ "get": {
+ "tags": [
+ "ExportPipelines"
+ ],
+ "description": "Lists all export pipelines for the specified container registry.",
+ "operationId": "ExportPipelines_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ExportPipelineListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExportPipelineList": {
+ "$ref": "./examples/ExportPipelineList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}": {
+ "get": {
+ "tags": [
+ "ExportPipelines"
+ ],
+ "description": "Gets the properties of the export pipeline.",
+ "operationId": "ExportPipelines_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExportPipelineNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ExportPipeline"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExportPipelineGet": {
+ "$ref": "./examples/ExportPipelineGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ExportPipelines"
+ ],
+ "description": "Creates an export pipeline for a container registry with the specified parameters.",
+ "operationId": "ExportPipelines_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExportPipelineNameParameter"
+ },
+ {
+ "name": "exportPipelineCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating an export pipeline.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportPipeline"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation has completed successfully.",
+ "schema": {
+ "$ref": "#/definitions/ExportPipeline"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ExportPipeline"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExportPipelineCreate": {
+ "$ref": "./examples/ExportPipelineCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "ExportPipelines"
+ ],
+ "description": "Deletes an export pipeline from a container registry.",
+ "operationId": "ExportPipelines_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ExportPipelineNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The export pipeline does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExportPipelineDelete": {
+ "$ref": "./examples/ExportPipelineDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Copies an image to this container registry from the specified container registry.",
+ "operationId": "Registries_ImportImage",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The parameters specifying the image to copy and the source container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImportImageParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation has completed successfully."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportImageByTag": {
+ "$ref": "./examples/ImportImageByTag.json"
+ },
+ "ImportImageByManifestDigest": {
+ "$ref": "./examples/ImportImageByManifestDigest.json"
+ },
+ "ImportImageFromPublicRegistry": {
+ "$ref": "./examples/ImportImageFromPublicRegistry.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines": {
+ "get": {
+ "tags": [
+ "ImportPipelines"
+ ],
+ "description": "Lists all import pipelines for the specified container registry.",
+ "operationId": "ImportPipelines_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ImportPipelineListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportPipelineList": {
+ "$ref": "./examples/ImportPipelineList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}": {
+ "get": {
+ "tags": [
+ "ImportPipelines"
+ ],
+ "description": "Gets the properties of the import pipeline.",
+ "operationId": "ImportPipelines_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ImportPipelineNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ImportPipeline"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportPipelineGet": {
+ "$ref": "./examples/ImportPipelineGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ImportPipelines"
+ ],
+ "description": "Creates an import pipeline for a container registry with the specified parameters.",
+ "operationId": "ImportPipelines_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ImportPipelineNameParameter"
+ },
+ {
+ "name": "importPipelineCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating an import pipeline.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImportPipeline"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation has completed successfully.",
+ "schema": {
+ "$ref": "#/definitions/ImportPipeline"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ImportPipeline"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportPipelineCreate": {
+ "$ref": "./examples/ImportPipelineCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImportPipelines"
+ ],
+ "description": "Deletes an import pipeline from a container registry.",
+ "operationId": "ImportPipelines_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ImportPipelineNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The import pipeline does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportPipelineDelete": {
+ "$ref": "./examples/ImportPipelineDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.ContainerRegistry/operations": {
+ "get": {
+ "tags": [
+ "Operation"
+ ],
+ "description": "Lists all of the available Azure Container Registry REST API operations.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OperationList": {
+ "$ref": "./examples/OperationList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "Operation"
+ ],
+ "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.",
+ "operationId": "Registries_CheckNameAvailability",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "registryNameCheckRequest",
+ "in": "body",
+ "description": "The object containing information for the availability request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegistryNameCheckRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryNameStatus"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryCheckNameAvailable": {
+ "$ref": "./examples/RegistryCheckNameAvailable.json"
+ },
+ "RegistryCheckNameNotAvailable": {
+ "$ref": "./examples/RegistryCheckNameNotAvailable.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns": {
+ "get": {
+ "tags": [
+ "PipelineRuns"
+ ],
+ "description": "Lists all the pipeline runs for the specified container registry.",
+ "operationId": "PipelineRuns_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well - formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PipelineRunListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PipelineRunList": {
+ "$ref": "./examples/PipelineRunList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}": {
+ "get": {
+ "tags": [
+ "PipelineRuns"
+ ],
+ "description": "Gets the detailed information for a given pipeline run.",
+ "operationId": "PipelineRuns_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PipelineRunNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well - formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PipelineRun"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PipelineRunGet": {
+ "$ref": "./examples/PipelineRunGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PipelineRuns"
+ ],
+ "description": "Creates a pipeline run for a container registry with the specified parameters",
+ "operationId": "PipelineRuns_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PipelineRunNameParameter"
+ },
+ {
+ "name": "pipelineRunCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a pipeline run.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PipelineRun"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well - formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PipelineRun"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/PipelineRun"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PipelineRunCreate_Export": {
+ "$ref": "./examples/PipelineRunCreate_Export.json"
+ },
+ "PipelineRunCreate_Import": {
+ "$ref": "./examples/PipelineRunCreate_Import.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "PipelineRuns"
+ ],
+ "description": "Deletes a pipeline run from a container registry.",
+ "operationId": "PipelineRuns_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PipelineRunNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The pipeline run does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PipelineRunDelete": {
+ "$ref": "./examples/PipelineRunDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "List all private endpoint connections in a container registry.",
+ "operationId": "PrivateEndpointConnections_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionList": {
+ "$ref": "./examples/PrivateEndpointConnectionList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Get the specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionGet": {
+ "$ref": "./examples/PrivateEndpointConnectionGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Update the state of specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ },
+ {
+ "name": "privateEndpointConnection",
+ "in": "body",
+ "description": "The parameters for creating a private endpoint connection.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionCreateOrUpdate": {
+ "$ref": "./examples/PrivateEndpointConnectionCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Deletes the specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The private endpoint connection does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionDelete": {
+ "$ref": "./examples/PrivateEndpointConnectionDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists all the container registries under the specified subscription.",
+ "operationId": "Registries_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryList": {
+ "$ref": "./examples/RegistryList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists all the container registries under the specified resource group.",
+ "operationId": "Registries_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListByResourceGroup": {
+ "$ref": "./examples/RegistryListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets the properties of the specified container registry.",
+ "operationId": "Registries_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGet": {
+ "$ref": "./examples/RegistryGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Creates a container registry with the specified parameters.",
+ "operationId": "Registries_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "registry",
+ "in": "body",
+ "description": "The parameters for creating a container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryCreate": {
+ "$ref": "./examples/RegistryCreate.json"
+ },
+ "RegistryCreateZoneRedundant": {
+ "$ref": "./examples/RegistryCreateZoneRedundant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Deletes a container registry.",
+ "operationId": "Registries_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The container registry does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "RegistryDelete": {
+ "$ref": "./examples/RegistryDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Updates a container registry with the specified parameters.",
+ "operationId": "Registries_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "registryUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegistryUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryUpdate": {
+ "$ref": "./examples/RegistryUpdate.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.ContainerRegistry/registries/{registryName}/listUsages": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets the quota usages for the specified container registry.",
+ "operationId": "Registries_ListUsages",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the registry usages retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryUsageListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListUsages": {
+ "$ref": "./examples/RegistryListUsages.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists the private link resources for a container registry.",
+ "operationId": "Registries_ListPrivateLinkResources",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the private link resources were retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListPrivateLinkResources": {
+ "$ref": "./examples/RegistryListPrivateLinkResources.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets a private link resource by a specified group name for a container registry.",
+ "operationId": "Registries_GetPrivateLinkResource",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the private link resource was retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGetPrivateLinkResource": {
+ "$ref": "./examples/RegistryGetPrivateLinkResource.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists the login credentials for the specified container registry.",
+ "operationId": "Registries_ListCredentials",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the list of credentials retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListCredentialsResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListCredentials": {
+ "$ref": "./examples/RegistryListCredentials.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Regenerates one of the login credentials for the specified container registry.",
+ "operationId": "Registries_RegenerateCredential",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "regenerateCredentialParameters",
+ "in": "body",
+ "description": "Specifies name of the password which should be regenerated -- password or password2.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegenerateCredentialParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the specified credential regenerated successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListCredentialsResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryRegenerateCredential": {
+ "$ref": "./examples/RegistryRegenerateCredential.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications": {
+ "get": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Lists all the replications for the specified container registry.",
+ "operationId": "Replications_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ReplicationListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationList": {
+ "$ref": "./examples/ReplicationList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}": {
+ "get": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Gets the properties of the specified replication.",
+ "operationId": "Replications_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationGet": {
+ "$ref": "./examples/ReplicationGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Creates a replication for a container registry with the specified parameters.",
+ "operationId": "Replications_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ },
+ {
+ "name": "replication",
+ "in": "body",
+ "description": "The parameters for creating a replication.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationCreate": {
+ "$ref": "./examples/ReplicationCreate.json"
+ },
+ "ReplicationCreateZoneRedundant": {
+ "$ref": "./examples/ReplicationCreateZoneRedundant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Deletes a replication from a container registry.",
+ "operationId": "Replications_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The replication does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationDelete": {
+ "$ref": "./examples/ReplicationDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Updates a replication for a container registry with the specified parameters.",
+ "operationId": "Replications_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ },
+ {
+ "name": "replicationUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a replication.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ReplicationUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationUpdate": {
+ "$ref": "./examples/ReplicationUpdate.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.ContainerRegistry/registries/{registryName}/scopeMaps": {
+ "get": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Lists all the scope maps for the specified container registry.",
+ "operationId": "ScopeMaps_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMapListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapList": {
+ "$ref": "./examples/ScopeMapList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}": {
+ "get": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Gets the properties of the specified scope map.",
+ "operationId": "ScopeMaps_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapGet": {
+ "$ref": "./examples/ScopeMapGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Creates a scope map for a container registry with the specified parameters.",
+ "operationId": "ScopeMaps_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ },
+ {
+ "name": "scopeMapCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a scope map.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapCreate": {
+ "$ref": "./examples/ScopeMapCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Deletes a scope map from a container registry.",
+ "operationId": "ScopeMaps_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The scopemap does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapDelete": {
+ "$ref": "./examples/ScopeMapDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Updates a scope map with the specified parameters.",
+ "operationId": "ScopeMaps_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ },
+ {
+ "name": "scopeMapUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a scope map.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopeMapUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapUpdate": {
+ "$ref": "./examples/ScopeMapUpdate.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.ContainerRegistry/registries/{registryName}/tokens": {
+ "get": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Lists all the tokens for the specified container registry.",
+ "operationId": "Tokens_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/TokenListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenList": {
+ "$ref": "./examples/TokenList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}": {
+ "get": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Gets the properties of the specified token.",
+ "operationId": "Tokens_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenGet": {
+ "$ref": "./examples/TokenGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Creates a token for a container registry with the specified parameters.",
+ "operationId": "Tokens_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ },
+ {
+ "name": "tokenCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a token.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenCreate": {
+ "$ref": "./examples/TokenCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Deletes a token from a container registry.",
+ "operationId": "Tokens_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The token does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenDelete": {
+ "$ref": "./examples/TokenDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Updates a token with the specified parameters.",
+ "operationId": "Tokens_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ },
+ {
+ "name": "tokenUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a token.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TokenUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenUpdate": {
+ "$ref": "./examples/TokenUpdate.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.ContainerRegistry/registries/{registryName}/generateCredentials": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Generate keys for a token of a specified container registry.",
+ "operationId": "Registries_GenerateCredentials",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "generateCredentialsParameters",
+ "in": "body",
+ "description": "The parameters for generating credentials.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenerateCredentialsParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/GenerateCredentialsResult"
+ }
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGenerateCredentials": {
+ "$ref": "./examples/RegistryGenerateCredentials.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Lists all the webhooks for the specified container registry.",
+ "operationId": "Webhooks_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/WebhookListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookList": {
+ "$ref": "./examples/WebhookList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Gets the properties of the specified webhook.",
+ "operationId": "Webhooks_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookGet": {
+ "$ref": "./examples/WebhookGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Creates a webhook for a container registry with the specified parameters.",
+ "operationId": "Webhooks_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ },
+ {
+ "name": "webhookCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a webhook.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WebhookCreateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookCreate": {
+ "$ref": "./examples/WebhookCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Deletes a webhook from a container registry.",
+ "operationId": "Webhooks_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The webhook does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "WebhookDelete": {
+ "$ref": "./examples/WebhookDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Updates a webhook with the specified parameters.",
+ "operationId": "Webhooks_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ },
+ {
+ "name": "webhookUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a webhook.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WebhookUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookUpdate": {
+ "$ref": "./examples/WebhookUpdate.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.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Triggers a ping event to be sent to the webhook.",
+ "operationId": "Webhooks_Ping",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/EventInfo"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookPing": {
+ "$ref": "./examples/WebhookPing.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Lists recent events for the specified webhook.",
+ "operationId": "Webhooks_ListEvents",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/EventListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookListEvents": {
+ "$ref": "./examples/WebhookListEvents.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Gets the configuration of service URI and custom headers for the webhook.",
+ "operationId": "Webhooks_GetCallbackConfig",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CallbackConfig"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookGetCallbackConfig": {
+ "$ref": "./examples/WebhookGetCallbackConfig.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "CacheRulesListResult": {
+ "description": "The result of a request to list cache rules for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of cache rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CacheRule"
+ }
+ },
+ "nextLink": {
+ "description": "If provided, client must use NextLink URI to request next list of cache rules.",
+ "type": "string"
+ }
+ }
+ },
+ "CacheRule": {
+ "description": "An object that represents a cache rule for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CacheRuleProperties",
+ "description": "The properties of the cache rule.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "InnerErrorDescription": {
+ "description": "inner error.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "properties": {
+ "code": {
+ "description": "error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "target of the particular error.",
+ "type": "string"
+ }
+ }
+ },
+ "CacheRuleProperties": {
+ "description": "The properties of a cache rule.",
+ "type": "object",
+ "properties": {
+ "credentialSetResourceId": {
+ "description": "The ARM resource ID of the credential store which is associated with the cache rule.",
+ "type": "string"
+ },
+ "sourceRepository": {
+ "description": "Source repository pulled from upstream.",
+ "type": "string"
+ },
+ "targetRepository": {
+ "description": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
+ "type": "string"
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of the cache rule.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CacheRuleUpdateParameters": {
+ "description": "The parameters for updating a cache rule.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CacheRuleUpdateProperties",
+ "description": "The properties of the cache rule update parameters.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CacheRuleUpdateProperties": {
+ "description": "The parameters for updating cache rule properties.",
+ "type": "object",
+ "properties": {
+ "credentialSetResourceId": {
+ "description": "The ARM resource ID of the credential store which is associated with the Cache rule.",
+ "type": "string"
+ }
+ }
+ },
+ "ConnectedRegistryListResult": {
+ "description": "The result of a request to list connected registries for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of connected registries. Since this list may be incomplete, the nextLink field should be used to request the next list of connected registries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ConnectedRegistry"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of connected registries.",
+ "type": "string"
+ }
+ }
+ },
+ "ConnectedRegistry": {
+ "description": "An object that represents a connected registry for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ConnectedRegistryProperties",
+ "description": "The properties of the connected registry.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ConnectedRegistryProperties": {
+ "description": "The properties of a connected registry.",
+ "required": [
+ "mode",
+ "parent"
+ ],
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "mode": {
+ "description": "The mode of the connected registry resource that indicates the permissions of the registry.",
+ "enum": [
+ "ReadWrite",
+ "ReadOnly",
+ "Registry",
+ "Mirror"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ConnectedRegistryMode",
+ "modelAsString": true
+ }
+ },
+ "version": {
+ "description": "The current version of ACR runtime on the connected registry.",
+ "type": "string",
+ "readOnly": true
+ },
+ "connectionState": {
+ "description": "The current connection state of the connected registry.",
+ "enum": [
+ "Online",
+ "Offline",
+ "Syncing",
+ "Unhealthy"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ConnectionState",
+ "modelAsString": true
+ }
+ },
+ "lastActivityTime": {
+ "format": "date-time",
+ "description": "The last activity time of the connected registry.",
+ "type": "string",
+ "readOnly": true
+ },
+ "activation": {
+ "$ref": "#/definitions/ActivationProperties",
+ "description": "The activation properties of the connected registry.",
+ "readOnly": true
+ },
+ "parent": {
+ "$ref": "#/definitions/ParentProperties",
+ "description": "The parent of the connected registry."
+ },
+ "clientTokenIds": {
+ "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loginServer": {
+ "$ref": "#/definitions/LoginServerProperties",
+ "description": "The login server properties of the connected registry."
+ },
+ "logging": {
+ "$ref": "#/definitions/LoggingProperties",
+ "description": "The logging properties of the connected registry."
+ },
+ "statusDetails": {
+ "description": "The list of current statuses of the connected registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StatusDetailProperties"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": [
+ "correlationId"
+ ]
+ },
+ "notificationsList": {
+ "description": "The list of notifications subscription information for the connected registry.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ActivationProperties": {
+ "description": "The activation properties of the connected registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The activation status of the connected registry.",
+ "enum": [
+ "Active",
+ "Inactive"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ActivationStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ParentProperties": {
+ "description": "The properties of the connected registry parent.",
+ "required": [
+ "syncProperties"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The resource ID of the parent to which the connected registry will be associated.",
+ "type": "string"
+ },
+ "syncProperties": {
+ "$ref": "#/definitions/SyncProperties",
+ "description": "The sync properties of the connected registry with its parent."
+ }
+ }
+ },
+ "LoginServerProperties": {
+ "description": "The login server properties of the connected registry.",
+ "type": "object",
+ "properties": {
+ "host": {
+ "description": "The host of the connected registry. Can be FQDN or IP.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tls": {
+ "$ref": "#/definitions/TlsProperties",
+ "description": "The TLS properties of the connected registry login server.",
+ "readOnly": true
+ }
+ }
+ },
+ "LoggingProperties": {
+ "description": "The logging properties of the connected registry.",
+ "type": "object",
+ "properties": {
+ "logLevel": {
+ "description": "The verbosity of logs persisted on the connected registry.",
+ "default": "Information",
+ "enum": [
+ "Debug",
+ "Information",
+ "Warning",
+ "Error",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": true
+ }
+ },
+ "auditLogStatus": {
+ "description": "Indicates whether audit logs are enabled on the connected registry.",
+ "default": "Disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AuditLogStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "StatusDetailProperties": {
+ "description": "The status detail properties of the connected registry.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The component of the connected registry corresponding to the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "code": {
+ "description": "The code of the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The description of the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "timestamp": {
+ "format": "date-time",
+ "description": "The timestamp of the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "The correlation ID of the status.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SyncProperties": {
+ "description": "The sync properties of the connected registry with its parent.",
+ "required": [
+ "tokenId",
+ "messageTtl"
+ ],
+ "type": "object",
+ "properties": {
+ "tokenId": {
+ "description": "The resource ID of the ACR token used to authenticate the connected registry to its parent during sync.",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "The cron expression indicating the schedule that the connected registry will sync with its parent.",
+ "type": "string"
+ },
+ "syncWindow": {
+ "format": "duration",
+ "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.",
+ "type": "string"
+ },
+ "messageTtl": {
+ "format": "duration",
+ "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.",
+ "type": "string"
+ },
+ "lastSyncTime": {
+ "format": "date-time",
+ "description": "The last time a sync occurred between the connected registry and its parent.",
+ "type": "string",
+ "readOnly": true
+ },
+ "gatewayEndpoint": {
+ "description": "The gateway endpoint used by the connected registry to communicate with its parent.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TlsProperties": {
+ "description": "The TLS properties of the connected registry login server.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Indicates whether HTTPS is enabled for the login server.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "TlsStatus",
+ "modelAsString": true
+ }
+ },
+ "certificate": {
+ "$ref": "#/definitions/TlsCertificateProperties",
+ "description": "The certificate used to configure HTTPS for the login server.",
+ "readOnly": true
+ }
+ }
+ },
+ "TlsCertificateProperties": {
+ "description": "The TLS certificate properties of the connected registry login server.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of certificate location.",
+ "enum": [
+ "LocalDirectory"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CertificateType",
+ "modelAsString": true
+ }
+ },
+ "location": {
+ "description": "Indicates the location of the certificates.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ConnectedRegistryUpdateParameters": {
+ "description": "The parameters for updating a connected registry.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ConnectedRegistryUpdateProperties",
+ "description": "The properties of the connected registry update parameters.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ConnectedRegistryUpdateProperties": {
+ "description": "The parameters for updating token properties.",
+ "type": "object",
+ "properties": {
+ "syncProperties": {
+ "$ref": "#/definitions/SyncUpdateProperties",
+ "description": "The sync properties of the connected registry with its parent."
+ },
+ "logging": {
+ "$ref": "#/definitions/LoggingProperties",
+ "description": "The logging properties of the connected registry."
+ },
+ "clientTokenIds": {
+ "description": "The list of the ACR token resource IDs used to authenticate clients to the connected registry.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "notificationsList": {
+ "description": "The list of notifications subscription information for the connected registry.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SyncUpdateProperties": {
+ "description": "The parameters for updating the sync properties of the connected registry with its parent.",
+ "type": "object",
+ "properties": {
+ "schedule": {
+ "description": "The cron expression indicating the schedule that the connected registry will sync with its parent.",
+ "type": "string"
+ },
+ "syncWindow": {
+ "format": "duration",
+ "description": "The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.",
+ "type": "string"
+ },
+ "messageTtl": {
+ "format": "duration",
+ "description": "The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601.",
+ "type": "string"
+ }
+ }
+ },
+ "CredentialSetListResult": {
+ "description": "The result of a request to list credential sets for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of credential sets. Since this list may be incomplete, the nextLink field should be used to request the next list of credential sets.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CredentialSet"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of credential sets.",
+ "type": "string"
+ }
+ }
+ },
+ "CredentialSet": {
+ "description": "An object that represents a credential set resource for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "Identities associated with the resource. This is used to access the KeyVault secrets."
+ },
+ "properties": {
+ "$ref": "#/definitions/CredentialSetProperties",
+ "description": "The properties of the credential set.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "IdentityProperties": {
+ "description": "Managed identity for the resource.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal ID of resource identity.",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "The tenant ID of resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The identity type.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserIdentityProperties"
+ }
+ }
+ }
+ },
+ "CredentialSetProperties": {
+ "description": "The properties of a credential set resource.",
+ "type": "object",
+ "properties": {
+ "loginServer": {
+ "description": "The credentials are stored for this upstream or login server.",
+ "type": "string"
+ },
+ "authCredentials": {
+ "description": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AuthCredential"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of credential store resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserIdentityProperties": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal id of user assigned identity.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "The client id of user assigned identity.",
+ "type": "string"
+ }
+ }
+ },
+ "Resource": {
+ "description": "An Azure resource.",
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "id": {
+ "description": "The resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "The location of the resource. This cannot be changed after the resource is created.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "The tags of the resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "systemData": {
+ "$ref": "#/definitions/SystemData",
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "AuthCredential": {
+ "description": "Authentication credential stored for an upstream.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the credential.",
+ "enum": [
+ "Credential1"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CredentialName",
+ "modelAsString": true
+ }
+ },
+ "usernameSecretIdentifier": {
+ "description": "KeyVault Secret URI for accessing the username.",
+ "type": "string"
+ },
+ "passwordSecretIdentifier": {
+ "description": "KeyVault Secret URI for accessing the password.",
+ "type": "string"
+ },
+ "credentialHealth": {
+ "$ref": "#/definitions/CredentialHealth",
+ "description": "This provides data pertaining to the health of the auth credential.",
+ "readOnly": true
+ }
+ }
+ },
+ "ProxyResource": {
+ "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.",
+ "properties": {
+ "id": {
+ "description": "The resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "#/definitions/SystemData",
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "CredentialHealth": {
+ "description": "The health of the auth credential.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The health status of credential.",
+ "enum": [
+ "Healthy",
+ "Unhealthy"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CredentialHealthStatus",
+ "modelAsString": true
+ }
+ },
+ "errorCode": {
+ "description": "Error code representing the health check error.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Descriptive message representing the health check error.",
+ "type": "string"
+ }
+ }
+ },
+ "SystemData": {
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "properties": {
+ "createdBy": {
+ "description": "The identity that created the resource.",
+ "type": "string"
+ },
+ "createdByType": {
+ "description": "The type of identity that created the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC).",
+ "type": "string"
+ },
+ "lastModifiedBy": {
+ "description": "The identity that last modified the resource.",
+ "type": "string"
+ },
+ "lastModifiedByType": {
+ "description": "The type of identity that last modified the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "lastModifiedByType",
+ "modelAsString": true
+ }
+ },
+ "lastModifiedAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource modification (UTC).",
+ "type": "string"
+ }
+ },
+ "readOnly": true
+ },
+ "ErrorResponseBody": {
+ "description": "An error response from the Azure Container Registry service.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "properties": {
+ "code": {
+ "description": "error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "target of the particular error.",
+ "type": "string"
+ },
+ "details": {
+ "description": "an array of additional nested error response info objects, as described by this contract.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InnerErrorDescription"
+ },
+ "x-ms-identifiers": [
+ "message",
+ "target"
+ ]
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "An error response from the Azure Container Registry service.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorResponseBody",
+ "description": "Azure container registry build API error body."
+ }
+ }
+ },
+ "CredentialSetUpdateParameters": {
+ "description": "The parameters for updating a credential set",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CredentialSetUpdateProperties",
+ "description": "The properties of the credential set update parameters",
+ "x-ms-client-flatten": true
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "Identities associated with the resource. This is used to access the KeyVault secrets."
+ }
+ }
+ },
+ "CredentialSetUpdateProperties": {
+ "description": "The parameters for updating credential set properties.",
+ "type": "object",
+ "properties": {
+ "authCredentials": {
+ "description": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AuthCredential"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "ExportPipelineListResult": {
+ "description": "The result of a request to list export pipelines for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of export pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of export pipelines.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ExportPipeline"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of pipeline runs.",
+ "type": "string"
+ }
+ }
+ },
+ "ExportPipeline": {
+ "description": "An object that represents an export pipeline for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "The location of the export pipeline.",
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the export pipeline."
+ },
+ "properties": {
+ "$ref": "#/definitions/ExportPipelineProperties",
+ "description": "The properties of the export pipeline.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ExportPipelineProperties": {
+ "description": "The properties of an export pipeline.",
+ "required": [
+ "target"
+ ],
+ "type": "object",
+ "properties": {
+ "target": {
+ "$ref": "#/definitions/ExportPipelineTargetProperties",
+ "description": "The target properties of the export pipeline."
+ },
+ "options": {
+ "description": "The list of all options configured for the pipeline.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "OverwriteTags",
+ "OverwriteBlobs",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PipelineOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the pipeline at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ExportPipelineTargetProperties": {
+ "description": "The properties of the export pipeline target.",
+ "required": [
+ "keyVaultUri"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of target for the export pipeline.",
+ "type": "string"
+ },
+ "uri": {
+ "description": "The target uri of the export pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\"",
+ "type": "string"
+ },
+ "keyVaultUri": {
+ "description": "They key vault secret uri to obtain the target storage SAS token.",
+ "type": "string"
+ }
+ }
+ },
+ "ImportImageParameters": {
+ "required": [
+ "source"
+ ],
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/ImportSource",
+ "description": "The source of the image."
+ },
+ "targetTags": {
+ "description": "List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "untaggedTargetRepositories": {
+ "description": "List of strings of repository names to do a manifest only copy. No tag will be created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mode": {
+ "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins.",
+ "default": "NoForce",
+ "enum": [
+ "NoForce",
+ "Force"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImportMode",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ImportSource": {
+ "required": [
+ "sourceImage"
+ ],
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The resource identifier of the source Azure Container Registry.",
+ "type": "string"
+ },
+ "registryUri": {
+ "description": "The address of the source registry (e.g. 'mcr.microsoft.com').",
+ "type": "string"
+ },
+ "credentials": {
+ "$ref": "#/definitions/ImportSourceCredentials",
+ "description": "Credentials used when importing from a registry uri."
+ },
+ "sourceImage": {
+ "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').",
+ "type": "string"
+ }
+ }
+ },
+ "ImportSourceCredentials": {
+ "required": [
+ "password"
+ ],
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username to authenticate with the source registry.",
+ "type": "string"
+ },
+ "password": {
+ "description": "The password used to authenticate with the source registry.",
+ "type": "string"
+ }
+ }
+ },
+ "ImportPipelineListResult": {
+ "description": "The result of a request to list import pipelines for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of import pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of import pipelines.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ImportPipeline"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of pipeline runs.",
+ "type": "string"
+ }
+ }
+ },
+ "ImportPipeline": {
+ "description": "An object that represents an import pipeline for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "The location of the import pipeline.",
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the import pipeline."
+ },
+ "properties": {
+ "$ref": "#/definitions/ImportPipelineProperties",
+ "description": "The properties of the import pipeline.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ImportPipelineProperties": {
+ "description": "The properties of an import pipeline.",
+ "required": [
+ "source"
+ ],
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/ImportPipelineSourceProperties",
+ "description": "The source properties of the import pipeline."
+ },
+ "trigger": {
+ "$ref": "#/definitions/PipelineTriggerProperties",
+ "description": "The properties that describe the trigger of the import pipeline."
+ },
+ "options": {
+ "description": "The list of all options configured for the pipeline.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "OverwriteTags",
+ "OverwriteBlobs",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PipelineOptions",
+ "modelAsString": true
+ }
+ }
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the pipeline at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ImportPipelineSourceProperties": {
+ "description": "The properties of the import pipeline source.",
+ "required": [
+ "keyVaultUri"
+ ],
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of source for the import pipeline.",
+ "default": "AzureStorageBlobContainer",
+ "enum": [
+ "AzureStorageBlobContainer"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PipelineSourceType",
+ "modelAsString": true
+ }
+ },
+ "uri": {
+ "description": "The source uri of the import pipeline.\r\nWhen 'AzureStorageBlob': \"https://accountName.blob.core.windows.net/containerName/blobName\"\r\nWhen 'AzureStorageBlobContainer': \"https://accountName.blob.core.windows.net/containerName\"",
+ "type": "string"
+ },
+ "keyVaultUri": {
+ "description": "They key vault secret uri to obtain the source storage SAS token.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineTriggerProperties": {
+ "type": "object",
+ "properties": {
+ "sourceTrigger": {
+ "$ref": "#/definitions/PipelineSourceTriggerProperties",
+ "description": "The source trigger properties of the pipeline."
+ }
+ }
+ },
+ "PipelineSourceTriggerProperties": {
+ "required": [
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The current status of the source trigger.",
+ "default": "Enabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TriggerStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "The result of a request to list container registry operations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of container registry operations.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDefinition": {
+ "description": "The definition of a container registry operation.",
+ "type": "object",
+ "properties": {
+ "origin": {
+ "description": "The origin information of the container registry operation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayDefinition",
+ "description": "The display information for the container registry operation."
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationPropertiesDefinition",
+ "description": "The properties information for the container registry operation.",
+ "x-ms-client-flatten": true
+ },
+ "isDataAction": {
+ "description": "This property indicates if the operation is an action or a data action\r\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations",
+ "type": "boolean"
+ }
+ }
+ },
+ "OperationDisplayDefinition": {
+ "description": "The display information for a container registry operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The resource provider name: Microsoft.ContainerRegistry.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "The resource on which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The operation that users can perform.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description for the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationPropertiesDefinition": {
+ "description": "The definition of Azure Monitoring properties.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/OperationServiceSpecificationDefinition",
+ "description": "The definition of Azure Monitoring service."
+ }
+ }
+ },
+ "OperationServiceSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring list.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "description": "A list of Azure Monitoring metrics definition.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationMetricSpecificationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "logSpecifications": {
+ "description": "A list of Azure Monitoring log definitions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationLogSpecificationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "OperationMetricSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring metric.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Metric name.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Metric display name.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "Metric description.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Metric unit.",
+ "type": "string"
+ },
+ "aggregationType": {
+ "description": "Metric aggregation type.",
+ "type": "string"
+ },
+ "internalMetricName": {
+ "description": "Internal metric name.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationLogSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring log.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Log name.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Log display name.",
+ "type": "string"
+ },
+ "blobDuration": {
+ "description": "Log blob duration.",
+ "type": "string"
+ }
+ }
+ },
+ "RegistryNameCheckRequest": {
+ "description": "A request to check whether a container registry name is available.",
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the container registry.",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "type": "string"
+ },
+ "type": {
+ "description": "The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'.",
+ "enum": [
+ "Microsoft.ContainerRegistry/registries"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContainerRegistryResourceType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "RegistryNameStatus": {
+ "description": "The result of a request to check the availability of a container registry name.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "The value that indicates whether the name is available.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "If any, the reason that the name is not available.",
+ "type": "string"
+ },
+ "message": {
+ "description": "If any, the error message that provides more detail for the reason that the name is not available.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRunListResult": {
+ "description": "The result of a request to list pipeline runs for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of pipeline runs. Since this list may be incomplete, the nextLink field should be used to request the next list of pipeline runs.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PipelineRun"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of pipeline runs.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRun": {
+ "description": "An object that represents a pipeline run for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PipelineRunProperties",
+ "description": "The properties of a pipeline run.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PipelineRunProperties": {
+ "description": "The properties of a pipeline run.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "The provisioning state of a pipeline run.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "request": {
+ "$ref": "#/definitions/PipelineRunRequest",
+ "description": "The request parameters for a pipeline run."
+ },
+ "response": {
+ "$ref": "#/definitions/PipelineRunResponse",
+ "description": "The response of a pipeline run.",
+ "readOnly": true
+ },
+ "forceUpdateTag": {
+ "description": "How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRunRequest": {
+ "description": "The request properties provided for a pipeline run.",
+ "type": "object",
+ "properties": {
+ "pipelineResourceId": {
+ "description": "The resource ID of the pipeline to run.",
+ "type": "string"
+ },
+ "artifacts": {
+ "description": "List of source artifacts to be transferred by the pipeline. \r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "source": {
+ "$ref": "#/definitions/PipelineRunSourceProperties",
+ "description": "The source properties of the pipeline run."
+ },
+ "target": {
+ "$ref": "#/definitions/PipelineRunTargetProperties",
+ "description": "The target properties of the pipeline run."
+ },
+ "catalogDigest": {
+ "description": "The digest of the tar used to transfer the artifacts.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRunResponse": {
+ "description": "The response properties returned for a pipeline run.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The current status of the pipeline run.",
+ "type": "string"
+ },
+ "importedArtifacts": {
+ "description": "The artifacts imported in the pipeline run.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "progress": {
+ "$ref": "#/definitions/ProgressProperties",
+ "description": "The current progress of the copy operation."
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "The time the pipeline run started.",
+ "type": "string"
+ },
+ "finishTime": {
+ "format": "date-time",
+ "description": "The time the pipeline run finished.",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "#/definitions/ImportPipelineSourceProperties",
+ "description": "The source of the pipeline run."
+ },
+ "target": {
+ "$ref": "#/definitions/ExportPipelineTargetProperties",
+ "description": "The target of the pipeline run."
+ },
+ "catalogDigest": {
+ "description": "The digest of the tar used to transfer the artifacts.",
+ "type": "string"
+ },
+ "trigger": {
+ "$ref": "#/definitions/PipelineTriggerDescriptor",
+ "description": "The trigger that caused the pipeline run."
+ },
+ "pipelineRunErrorMessage": {
+ "description": "The detailed error message for the pipeline run in the case of failure.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRunSourceProperties": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the source.",
+ "default": "AzureStorageBlob",
+ "enum": [
+ "AzureStorageBlob"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PipelineRunSourceType",
+ "modelAsString": true
+ }
+ },
+ "name": {
+ "description": "The name of the source.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineRunTargetProperties": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the target.",
+ "default": "AzureStorageBlob",
+ "enum": [
+ "AzureStorageBlob"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PipelineRunTargetType",
+ "modelAsString": true
+ }
+ },
+ "name": {
+ "description": "The name of the target.",
+ "type": "string"
+ }
+ }
+ },
+ "ProgressProperties": {
+ "type": "object",
+ "properties": {
+ "percentage": {
+ "description": "The percentage complete of the copy operation.",
+ "type": "string"
+ }
+ }
+ },
+ "PipelineTriggerDescriptor": {
+ "type": "object",
+ "properties": {
+ "sourceTrigger": {
+ "$ref": "#/definitions/PipelineSourceTriggerDescriptor",
+ "description": "The source trigger that caused the pipeline run."
+ }
+ }
+ },
+ "PipelineSourceTriggerDescriptor": {
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "format": "date-time",
+ "description": "The timestamp when the source update happened.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnectionListResult": {
+ "description": "The result of a request to list private endpoint connections for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private endpoint connections.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "An object that represents a private endpoint connection for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties of a private endpoint connection.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateEndpointConnectionProperties": {
+ "description": "The properties of a private endpoint connection.",
+ "type": "object",
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "description": "The provisioning state of private endpoint connection resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateEndpoint": {
+ "description": "The Private Endpoint resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "This is private endpoint resource created with Microsoft.Network resource provider.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionState": {
+ "description": "The state of a private link service connection.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The private link service connection status.",
+ "enum": [
+ "Approved",
+ "Pending",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection.",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "A message indicating if changes on the service provider require any updates on the consumer.",
+ "enum": [
+ "None",
+ "Recreate"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ActionsRequired",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RegistryListResult": {
+ "description": "The result of a request to list container registries.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of container registries.",
+ "type": "string"
+ }
+ }
+ },
+ "Registry": {
+ "description": "An object that represents a container registry.",
+ "required": [
+ "sku"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the container registry."
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the container registry."
+ },
+ "properties": {
+ "$ref": "#/definitions/RegistryProperties",
+ "description": "The properties of the container registry.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Sku": {
+ "description": "The SKU of a container registry.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The SKU name of the container registry. Required for registry creation.",
+ "enum": [
+ "Classic",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "description": "The SKU tier based on the SKU name.",
+ "enum": [
+ "Classic",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RegistryProperties": {
+ "description": "The properties of a container registry.",
+ "type": "object",
+ "properties": {
+ "loginServer": {
+ "description": "The URL that can be used to log into the container registry.",
+ "type": "string",
+ "readOnly": true
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of the container registry in ISO8601 format.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the container registry at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "$ref": "#/definitions/Status",
+ "description": "The status of the container registry at the time the operation was called.",
+ "readOnly": true
+ },
+ "adminUserEnabled": {
+ "description": "The value that indicates whether the admin user is enabled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "networkRuleSet": {
+ "$ref": "#/definitions/NetworkRuleSet",
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "$ref": "#/definitions/Policies",
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "$ref": "#/definitions/EncryptionProperty",
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "description": "Enable a single data endpoint per region for serving data.",
+ "type": "boolean"
+ },
+ "dataEndpointHostNames": {
+ "description": "List of host names that will serve data when dataEndpointEnabled is true.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "privateEndpointConnections": {
+ "description": "List of private endpoint connections for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the container registry.",
+ "default": "Enabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
+ "networkRuleBypassOptions": {
+ "description": "Whether to allow trusted Azure services to access a network restricted registry.",
+ "default": "AzureServices",
+ "enum": [
+ "AzureServices",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkRuleBypassOptions",
+ "modelAsString": true
+ }
+ },
+ "zoneRedundancy": {
+ "description": "Whether or not zone redundancy is enabled for this container registry",
+ "default": "Disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ZoneRedundancy",
+ "modelAsString": true
+ }
+ },
+ "anonymousPullEnabled": {
+ "description": "Enables registry-wide pull from unauthenticated clients.",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "Status": {
+ "description": "The status of an Azure resource at the time the operation was called.",
+ "type": "object",
+ "properties": {
+ "displayStatus": {
+ "description": "The short label for the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The detailed message for the status, including alerts and error messages.",
+ "type": "string",
+ "readOnly": true
+ },
+ "timestamp": {
+ "format": "date-time",
+ "description": "The timestamp when the status was changed to the current value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountProperties": {
+ "description": "The properties of a storage account for a container registry. Only applicable to Classic SKU.",
+ "required": [
+ "id"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The resource ID of the storage account.",
+ "type": "string"
+ }
+ }
+ },
+ "NetworkRuleSet": {
+ "description": "The network rule set for a container registry.",
+ "required": [
+ "defaultAction"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultAction": {
+ "description": "The default action of allow or deny when no other rules match.",
+ "default": "Allow",
+ "enum": [
+ "Allow",
+ "Deny"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DefaultAction",
+ "modelAsString": true
+ }
+ },
+ "ipRules": {
+ "description": "The IP ACL rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IPRule"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "Policies": {
+ "description": "The policies for a container registry.",
+ "type": "object",
+ "properties": {
+ "quarantinePolicy": {
+ "$ref": "#/definitions/QuarantinePolicy",
+ "description": "The quarantine policy for a container registry."
+ },
+ "trustPolicy": {
+ "$ref": "#/definitions/TrustPolicy",
+ "description": "The content trust policy for a container registry."
+ },
+ "retentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy",
+ "description": "The retention policy for a container registry."
+ },
+ "exportPolicy": {
+ "$ref": "#/definitions/ExportPolicy",
+ "description": "The export policy for a container registry."
+ },
+ "azureADAuthenticationAsArmPolicy": {
+ "$ref": "#/definitions/AzureADAuthenticationAsArmPolicy",
+ "description": "The policy for using ARM audience token for a container registry."
+ },
+ "softDeletePolicy": {
+ "$ref": "#/definitions/SoftDeletePolicy",
+ "description": "The soft delete policy for a container registry."
+ }
+ }
+ },
+ "EncryptionProperty": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the encryption is enabled for container registry.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EncryptionStatus",
+ "modelAsString": true
+ }
+ },
+ "keyVaultProperties": {
+ "$ref": "#/definitions/KeyVaultProperties",
+ "description": "Key vault properties."
+ }
+ }
+ },
+ "PackageType": {
+ "description": "The properties of a package type.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the package type.",
+ "type": "string"
+ },
+ "endpoint": {
+ "description": "The endpoint of the package type.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "IPRule": {
+ "description": "IP rule with specific IP or IP range in CIDR format.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action of IP ACL rule.",
+ "default": "Allow",
+ "enum": [
+ "Allow"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Action",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.",
+ "type": "string",
+ "x-ms-client-name": "IPAddressOrRange"
+ }
+ }
+ },
+ "QuarantinePolicy": {
+ "description": "The quarantine policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TrustPolicy": {
+ "description": "The content trust policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of trust policy.",
+ "default": "Notary",
+ "enum": [
+ "Notary"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TrustPolicyType",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RetentionPolicy": {
+ "description": "The retention policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "days": {
+ "format": "int32",
+ "description": "The number of days to retain an untagged manifest after which it gets purged.",
+ "default": 7,
+ "type": "integer"
+ },
+ "lastUpdatedTime": {
+ "format": "date-time",
+ "description": "The timestamp when the policy was last updated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ExportPolicy": {
+ "description": "The export policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "enabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ExportPolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AzureADAuthenticationAsArmPolicy": {
+ "description": "The policy for using ARM audience token for a container registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "enabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureADAuthenticationAsArmPolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "SoftDeletePolicy": {
+ "description": "The soft delete policy for a container registry",
+ "type": "object",
+ "properties": {
+ "retentionDays": {
+ "format": "int32",
+ "description": "The number of days after which a soft-deleted item is permanently deleted.",
+ "default": 7,
+ "type": "integer"
+ },
+ "lastUpdatedTime": {
+ "format": "date-time",
+ "description": "The timestamp when the policy was last updated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KeyVaultProperties": {
+ "type": "object",
+ "properties": {
+ "keyIdentifier": {
+ "description": "Key vault uri to access the encryption key.",
+ "type": "string"
+ },
+ "versionedKeyIdentifier": {
+ "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption.",
+ "type": "string",
+ "readOnly": true
+ },
+ "identity": {
+ "description": "The client id of the identity which will be used to access key vault.",
+ "type": "string"
+ },
+ "keyRotationEnabled": {
+ "description": "Auto key rotation status for a CMK enabled registry.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "lastKeyRotationTimestamp": {
+ "format": "date-time",
+ "description": "Timestamp of the last successful key rotation.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RegistryUpdateParameters": {
+ "description": "The parameters for updating a container registry.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the container registry."
+ },
+ "tags": {
+ "description": "The tags for the container registry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the container registry."
+ },
+ "properties": {
+ "$ref": "#/definitions/RegistryPropertiesUpdateParameters",
+ "description": "The properties that the container registry will be updated with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RegistryPropertiesUpdateParameters": {
+ "description": "The parameters for updating the properties of a container registry.",
+ "type": "object",
+ "properties": {
+ "adminUserEnabled": {
+ "description": "The value that indicates whether the admin user is enabled.",
+ "type": "boolean"
+ },
+ "networkRuleSet": {
+ "$ref": "#/definitions/NetworkRuleSet",
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "$ref": "#/definitions/Policies",
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "$ref": "#/definitions/EncryptionProperty",
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "description": "Enable a single data endpoint per region for serving data.",
+ "type": "boolean"
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the container registry.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
+ "networkRuleBypassOptions": {
+ "description": "Whether to allow trusted Azure services to access a network restricted registry.",
+ "default": "AzureServices",
+ "enum": [
+ "AzureServices",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkRuleBypassOptions",
+ "modelAsString": true
+ }
+ },
+ "anonymousPullEnabled": {
+ "description": "Enables registry-wide pull from unauthenticated clients.",
+ "type": "boolean"
+ }
+ }
+ },
+ "RegistryUsageListResult": {
+ "description": "The result of a request to get container registry quota usages.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registry quota usages.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RegistryUsage"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "RegistryUsage": {
+ "description": "The quota usage for a container registry.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the usage.",
+ "type": "string"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The limit of the usage.",
+ "type": "integer"
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "The current value of the usage.",
+ "type": "integer"
+ },
+ "unit": {
+ "description": "The unit of measurement.",
+ "enum": [
+ "Count",
+ "Bytes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RegistryUsageUnit",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateLinkResourceListResult": {
+ "description": "The result of a request to list private link resources for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private link resources.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A resource that supports private link capabilities.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The resource type is private link resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "The resource ID.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "A resource that supports private link capabilities.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateLinkResourceProperties": {
+ "description": "The properties of a private link resource.",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string"
+ },
+ "requiredMembers": {
+ "description": "The private link resource required member names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requiredZoneNames": {
+ "description": "The private link resource Private link DNS zone name.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "RegistryListCredentialsResult": {
+ "description": "The response from the ListCredentials operation.",
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username for a container registry.",
+ "type": "string"
+ },
+ "passwords": {
+ "description": "The list of passwords for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RegistryPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "RegistryPassword": {
+ "description": "The login password for the container registry.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The password name.",
+ "enum": [
+ "password",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PasswordName",
+ "modelAsString": false
+ }
+ },
+ "value": {
+ "description": "The password value.",
+ "type": "string"
+ }
+ }
+ },
+ "RegenerateCredentialParameters": {
+ "description": "The parameters used to regenerate the login credential.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Specifies name of the password which should be regenerated -- password or password2.",
+ "enum": [
+ "password",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PasswordName",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "ReplicationListResult": {
+ "description": "The result of a request to list replications for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of replications.",
+ "type": "string"
+ }
+ }
+ },
+ "Replication": {
+ "description": "An object that represents a replication for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ReplicationProperties",
+ "description": "The properties of the replication.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ReplicationProperties": {
+ "description": "The properties of a replication.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "The provisioning state of the replication at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "$ref": "#/definitions/Status",
+ "description": "The status of the replication at the time the operation was called.",
+ "readOnly": true
+ },
+ "regionEndpointEnabled": {
+ "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.",
+ "default": true,
+ "type": "boolean"
+ },
+ "zoneRedundancy": {
+ "description": "Whether or not zone redundancy is enabled for this container registry replication",
+ "default": "Disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ZoneRedundancy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ReplicationUpdateParameters": {
+ "description": "The parameters for updating a replication.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the replication.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/ReplicationUpdateParametersProperties",
+ "description": "The parameters for updating a replication's properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ReplicationUpdateParametersProperties": {
+ "type": "object",
+ "properties": {
+ "regionEndpointEnabled": {
+ "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ScopeMapListResult": {
+ "description": "The result of a request to list scope maps for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of scope maps.",
+ "type": "string"
+ }
+ }
+ },
+ "ScopeMap": {
+ "description": "An object that represents a scope map for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ScopeMapProperties",
+ "description": "The properties of the scope map.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ScopeMapProperties": {
+ "description": "The properties of a scope map.",
+ "required": [
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The user friendly description of the scope map.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the scope map. E.g. BuildIn scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "actions": {
+ "description": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ScopeMapUpdateParameters": {
+ "description": "The properties for updating the scope map.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ScopeMapPropertiesUpdateParameters",
+ "description": "The update parameters for scope map properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ScopeMapPropertiesUpdateParameters": {
+ "description": "The update parameters for scope map properties.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The user friendly description of the scope map.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of scope permissions for registry artifacts.\r\nE.g. repositories/repository-name/pull, \r\nrepositories/repository-name/delete",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TokenListResult": {
+ "description": "The result of a request to list tokens for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of tokens.",
+ "type": "string"
+ }
+ }
+ },
+ "Token": {
+ "description": "An object that represents a token for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TokenProperties",
+ "description": "The properties of the token.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TokenProperties": {
+ "description": "The properties of a token.",
+ "type": "object",
+ "properties": {
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "scopeMapId": {
+ "description": "The resource ID of the scope map to which the token will be associated with.",
+ "type": "string"
+ },
+ "credentials": {
+ "$ref": "#/definitions/TokenCredentialsProperties",
+ "description": "The credentials that can be used for authenticating the token."
+ },
+ "status": {
+ "description": "The status of the token example enabled or disabled.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TokenCredentialsProperties": {
+ "description": "The properties of the credentials that can be used for authenticating the token.",
+ "type": "object",
+ "properties": {
+ "certificates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenCertificate"
+ },
+ "x-ms-identifiers": [
+ "thumbprint"
+ ]
+ },
+ "passwords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ActiveDirectoryObject": {
+ "description": "The Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "string"
+ }
+ }
+ },
+ "TokenCertificate": {
+ "description": "The properties of a certificate used for authenticating a token.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "enum": [
+ "certificate1",
+ "certificate2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenCertificateName",
+ "modelAsString": true
+ }
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry datetime of the certificate.",
+ "type": "string"
+ },
+ "thumbprint": {
+ "description": "The thumbprint of the certificate.",
+ "type": "string"
+ },
+ "encodedPemCertificate": {
+ "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token.",
+ "type": "string"
+ }
+ }
+ },
+ "TokenPassword": {
+ "description": "The password that will be used for authenticating the token of a container registry.",
+ "type": "object",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "description": "The creation datetime of the password.",
+ "type": "string"
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry datetime of the password.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The password name \"password1\" or \"password2\"",
+ "enum": [
+ "password1",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenPasswordName",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "The password value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TokenUpdateParameters": {
+ "description": "The parameters for updating a token.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TokenUpdateProperties",
+ "description": "The properties of the token update parameters.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TokenUpdateProperties": {
+ "description": "The parameters for updating token properties.",
+ "type": "object",
+ "properties": {
+ "scopeMapId": {
+ "description": "The resource ID of the scope map to which the token will be associated with.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the token example enabled or disabled.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenStatus",
+ "modelAsString": true
+ }
+ },
+ "credentials": {
+ "$ref": "#/definitions/TokenCredentialsProperties",
+ "description": "The credentials that can be used for authenticating the token."
+ }
+ }
+ },
+ "GenerateCredentialsParameters": {
+ "description": "The parameters used to generate credentials for a specified token or user of a container registry.",
+ "type": "object",
+ "properties": {
+ "tokenId": {
+ "description": "The resource ID of the token for which credentials have to be generated.",
+ "type": "string"
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry date of the generated credentials after which the credentials become invalid.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Specifies name of the password which should be regenerated if any -- password1 or password2.",
+ "enum": [
+ "password1",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenPasswordName",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "GenerateCredentialsResult": {
+ "description": "The response from the GenerateCredentials operation.",
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username for a container registry.",
+ "type": "string"
+ },
+ "passwords": {
+ "description": "The list of passwords for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "WebhookListResult": {
+ "description": "The result of a request to list webhooks for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of webhooks.",
+ "type": "string"
+ }
+ }
+ },
+ "Webhook": {
+ "description": "An object that represents a webhook for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebhookProperties",
+ "description": "The properties of the webhook.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookProperties": {
+ "description": "The properties of a webhook.",
+ "required": [
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the webhook at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "WebhookCreateParameters": {
+ "description": "The parameters for creating a webhook.",
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the webhook.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "location": {
+ "description": "The location of the webhook. This cannot be changed after the resource is created.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/WebhookPropertiesCreateParameters",
+ "description": "The properties that the webhook will be created with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookPropertiesCreateParameters": {
+ "description": "The parameters for creating the properties of a webhook.",
+ "required": [
+ "serviceUri",
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-secret": true
+ },
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "WebhookUpdateParameters": {
+ "description": "The parameters for updating a webhook.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the webhook.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/WebhookPropertiesUpdateParameters",
+ "description": "The properties that the webhook will be updated with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookPropertiesUpdateParameters": {
+ "description": "The parameters for updating the properties of a webhook.",
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-secret": true
+ },
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "EventInfo": {
+ "description": "The basic information of an event.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The event ID.",
+ "type": "string"
+ }
+ }
+ },
+ "EventListResult": {
+ "description": "The result of a request to list events for a webhook.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of events.",
+ "type": "string"
+ }
+ }
+ },
+ "Event": {
+ "description": "The event for a webhook.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventInfo"
+ }
+ ],
+ "properties": {
+ "eventRequestMessage": {
+ "$ref": "#/definitions/EventRequestMessage",
+ "description": "The event request message sent to the service URI."
+ },
+ "eventResponseMessage": {
+ "$ref": "#/definitions/EventResponseMessage",
+ "description": "The event response message received from the service URI."
+ }
+ }
+ },
+ "EventRequestMessage": {
+ "description": "The event request message sent to the service URI.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "$ref": "#/definitions/EventContent",
+ "description": "The content of the event request message."
+ },
+ "headers": {
+ "description": "The headers of the event request message.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "method": {
+ "description": "The HTTP method used to send the event request message.",
+ "type": "string"
+ },
+ "requestUri": {
+ "description": "The URI used to send the event request message.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The HTTP message version.",
+ "type": "string"
+ }
+ }
+ },
+ "EventResponseMessage": {
+ "description": "The event response message received from the service URI.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The content of the event response message.",
+ "type": "string"
+ },
+ "headers": {
+ "description": "The headers of the event response message.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "reasonPhrase": {
+ "description": "The reason phrase of the event response message.",
+ "type": "string"
+ },
+ "statusCode": {
+ "description": "The status code of the event response message.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The HTTP message version.",
+ "type": "string"
+ }
+ }
+ },
+ "EventContent": {
+ "description": "The content of the event request message.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The event ID.",
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "date-time",
+ "description": "The time at which the event occurred.",
+ "type": "string"
+ },
+ "action": {
+ "description": "The action that encompasses the provided event.",
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/definitions/Target",
+ "description": "The target of the event."
+ },
+ "request": {
+ "$ref": "#/definitions/Request",
+ "description": "The request that generated the event."
+ },
+ "actor": {
+ "$ref": "#/definitions/Actor",
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request."
+ },
+ "source": {
+ "$ref": "#/definitions/Source",
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it."
+ }
+ }
+ },
+ "Target": {
+ "description": "The target of the event.",
+ "type": "object",
+ "properties": {
+ "mediaType": {
+ "description": "The MIME type of the referenced object.",
+ "type": "string"
+ },
+ "size": {
+ "format": "int64",
+ "description": "The number of bytes of the content. Same as Length field.",
+ "type": "integer"
+ },
+ "digest": {
+ "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification.",
+ "type": "string"
+ },
+ "length": {
+ "format": "int64",
+ "description": "The number of bytes of the content. Same as Size field.",
+ "type": "integer"
+ },
+ "repository": {
+ "description": "The repository name.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The direct URL to the content.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "The tag name.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the artifact.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the artifact.",
+ "type": "string"
+ }
+ }
+ },
+ "Request": {
+ "description": "The request that generated the event.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the request that initiated the event.",
+ "type": "string"
+ },
+ "addr": {
+ "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.",
+ "type": "string"
+ },
+ "host": {
+ "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.",
+ "type": "string"
+ },
+ "method": {
+ "description": "The request method that generated the event.",
+ "type": "string"
+ },
+ "useragent": {
+ "description": "The user agent header of the request.",
+ "type": "string"
+ }
+ }
+ },
+ "Actor": {
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The subject or username associated with the request context that generated the event.",
+ "type": "string"
+ }
+ }
+ },
+ "Source": {
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.",
+ "type": "object",
+ "properties": {
+ "addr": {
+ "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.",
+ "type": "string"
+ },
+ "instanceID": {
+ "description": "The running instance of an application. Changes after each restart.",
+ "type": "string"
+ }
+ }
+ },
+ "CallbackConfig": {
+ "description": "The configuration of service URI and custom headers for the webhook.",
+ "required": [
+ "serviceUri"
+ ],
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string"
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "RegistryNameParameter": {
+ "name": "registryName",
+ "in": "path",
+ "description": "The name of the container registry.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "WebhookNameParameter": {
+ "name": "webhookName",
+ "in": "path",
+ "description": "The name of the webhook.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ReplicationNameParameter": {
+ "name": "replicationName",
+ "in": "path",
+ "description": "The name of the replication.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ScopeMapNameParameter": {
+ "name": "scopeMapName",
+ "in": "path",
+ "description": "The name of the scope map.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-_]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "TokenNameParameter": {
+ "name": "tokenName",
+ "in": "path",
+ "description": "The name of the token.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "PrivateEndpointConnectionNameParameter": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "GroupNameParameter": {
+ "name": "groupName",
+ "in": "path",
+ "description": "The name of the private link resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ExportPipelineNameParameter": {
+ "name": "exportPipelineName",
+ "in": "path",
+ "description": "The name of the export pipeline.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ImportPipelineNameParameter": {
+ "name": "importPipelineName",
+ "in": "path",
+ "description": "The name of the import pipeline.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "PipelineRunNameParameter": {
+ "name": "pipelineRunName",
+ "in": "path",
+ "description": "The name of the pipeline run.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ConnectedRegistryNameParameter": {
+ "name": "connectedRegistryName",
+ "in": "path",
+ "description": "The name of the connected registry.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ConnectedRegistryFilterParameter": {
+ "name": "$filter",
+ "in": "query",
+ "description": "An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "CredentialSetNameParameter": {
+ "name": "credentialSetName",
+ "in": "path",
+ "description": "The name of the credential set.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "CacheRuleNameParameter": {
+ "name": "cacheRuleName",
+ "in": "path",
+ "description": "The name of the cache rule.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-]*$",
+ "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/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleCreate.json
new file mode 100644
index 000000000000..ac8d229d2cfb
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleCreate.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "cacheRuleName": "myCacheRule",
+ "cacheRuleCreateParameters": {
+ "properties": {
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule/operationStatuses/cacherules-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleDelete.json
new file mode 100644
index 000000000000..279be29c1c8e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "cacheRuleName": "myCacheRule"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule/operationStatuses/cacherules-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleGet.json
new file mode 100644
index 000000000000..f944841afd0c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleGet.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "cacheRuleName": "myCacheRule"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleList.json
new file mode 100644
index 000000000000..6061020c25c4
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleList.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleUpdate.json
new file mode 100644
index 000000000000..1f940c21a5e4
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CacheRuleUpdate.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "cacheRuleName": "myCacheRule",
+ "cacheRuleUpdateParameters": {
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet2",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule/operationStatuses/cacherules-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/cacheRules",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/cacheRules/myCacheRule",
+ "name": "myCacheRule",
+ "properties": {
+ "credentialSetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet2",
+ "sourceRepository": "docker.io/library/hello-world",
+ "targetRepository": "cached-docker-hub/hello-world",
+ "creationDate": "2022-11-07T18:20:33.8374968+00:00",
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryCreate.json
new file mode 100644
index 000000000000..672662da68c5
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryCreate.json
@@ -0,0 +1,98 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "connectedRegistryName": "myConnectedRegistry",
+ "connectedRegistryCreateParameters": {
+ "properties": {
+ "mode": "ReadWrite",
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 9 * * *",
+ "messageTtl": "P2D",
+ "syncWindow": "PT3H"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token"
+ ],
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "activation": {
+ "status": "Inactive"
+ },
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 9 * * *",
+ "messageTtl": "P2D",
+ "syncWindow": "PT3H"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token"
+ ],
+ "logging": {
+ "logLevel": "Information",
+ "auditLogStatus": "Disabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry/operationStatuses/connectedregistries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "activation": {
+ "status": "Inactive"
+ },
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 9 * * *",
+ "messageTtl": "P2D",
+ "syncWindow": "PT3H"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token"
+ ],
+ "logging": {
+ "logLevel": "Information",
+ "auditLogStatus": "Disabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDeactivate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDeactivate.json
new file mode 100644
index 000000000000..d77a9453e83c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDeactivate.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "connectedRegistryName": "myConnectedRegistry"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry/operationStatuses/connectedregistries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDelete.json
new file mode 100644
index 000000000000..d9c4b28c724f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "connectedRegistryName": "myConnectedRegistry"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry/operationStatuses/connectedregistries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryGet.json
new file mode 100644
index 000000000000..f486f5278676
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryGet.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "connectedRegistryName": "myConnectedRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "activation": {
+ "status": "Inactive"
+ },
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 9 * * *",
+ "messageTtl": "P2D",
+ "syncWindow": "PT3H"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token"
+ ],
+ "logging": {
+ "logLevel": "Information",
+ "auditLogStatus": "Disabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryList.json
new file mode 100644
index 000000000000..91b03c5810de
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryList.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "activation": {
+ "status": "Inactive"
+ },
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 9 * * *",
+ "messageTtl": "P2D",
+ "syncWindow": "PT3H"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token"
+ ],
+ "logging": {
+ "logLevel": "Information",
+ "auditLogStatus": "Disabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryUpdate.json
new file mode 100644
index 000000000000..6042fcbe1bdb
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ConnectedRegistryUpdate.json
@@ -0,0 +1,95 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "connectedRegistryName": "myScopeMap",
+ "connectedRegistryUpdateParameters": {
+ "properties": {
+ "syncProperties": {
+ "schedule": "0 0 */10 * *",
+ "messageTtl": "P30D",
+ "syncWindow": "P2D"
+ },
+ "logging": {
+ "logLevel": "Debug",
+ "auditLogStatus": "Enabled"
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
+ ],
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 0 */10 * *",
+ "messageTtl": "P30D",
+ "syncWindow": "P2D"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
+ ],
+ "logging": {
+ "logLevel": "Debug",
+ "auditLogStatus": "Enabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry/operationStatuses/connectedregistries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
+ "name": "myConnectedRegistry",
+ "type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
+ "properties": {
+ "mode": "ReadWrite",
+ "parent": {
+ "syncProperties": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
+ "schedule": "0 0 */10 * *",
+ "messageTtl": "P30D",
+ "syncWindow": "P2D"
+ }
+ },
+ "clientTokenIds": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
+ ],
+ "logging": {
+ "logLevel": "Debug",
+ "auditLogStatus": "Enabled"
+ },
+ "notificationsList": [
+ "hello-world:*:*",
+ "sample/repo/*:1.0:*"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetCreate.json
new file mode 100644
index 000000000000..22e53abd7aee
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetCreate.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "credentialSetName": "myCredentialSet",
+ "credentialSetCreateParameters": {
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password"
+ }
+ ]
+ },
+ "identity": {
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet/operationStatuses/credentialsets-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetDelete.json
new file mode 100644
index 000000000000..c4072f1d6e4f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "credentialSetName": "myCredentialSet"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet/operationStatuses/credentialsets-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetGet.json
new file mode 100644
index 000000000000..294c065b8027
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetGet.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "credentialSetName": "myCredentialSet"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetList.json
new file mode 100644
index 000000000000..9a8f11919977
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetList.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetUpdate.json
new file mode 100644
index 000000000000..179ac60bb2b3
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/CredentialSetUpdate.json
@@ -0,0 +1,79 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "credentialSetName": "myCredentialSet",
+ "credentialSetUpdateParameters": {
+ "properties": {
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet/operationStatuses/credentialsets-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "type": "Microsoft.ContainerRegistry/registries/credentialSets",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/credentialSets/myCredentialSet",
+ "name": "myCredentialSet",
+ "properties": {
+ "loginServer": "docker.io",
+ "authCredentials": [
+ {
+ "name": "Credential1",
+ "usernameSecretIdentifier": "https://myvault.vault.azure.net/secrets/username2",
+ "passwordSecretIdentifier": "https://myvault.vault.azure.net/secrets/password2",
+ "credentialHealth": {
+ "status": "Healthy"
+ }
+ }
+ ],
+ "creationDate": "2022-11-07T18:20:08.012276+00:00",
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineCreate.json
new file mode 100644
index 000000000000..014c315b7060
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineCreate.json
@@ -0,0 +1,78 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "exportPipelineName": "myExportPipeline",
+ "exportPipelineCreateParameters": {
+ "location": "westus",
+ "identity": {
+ "type": "SystemAssigned"
+ },
+ "properties": {
+ "target": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ },
+ "options": [
+ "OverwriteBlobs"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "name": "myExportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/exportPipelines",
+ "properties": {
+ "target": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ },
+ "options": [
+ "OverwriteBlobs"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
+ "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
+ "type": "SystemAssigned"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline/operationStatuses/exportpipelines-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "name": "myExportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/exportPipelines",
+ "properties": {
+ "target": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ },
+ "options": [
+ "OverwriteBlobs"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
+ "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
+ "type": "SystemAssigned"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineDelete.json
new file mode 100644
index 000000000000..7902741db670
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "exportPipelineName": "myExportPipeline"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline/operationStatuses/exportpipelines-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineGet.json
new file mode 100644
index 000000000000..92dce0847d19
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineGet.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "exportPipelineName": "myExportPipeline"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "name": "myExportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/exportPipelines",
+ "properties": {
+ "target": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ },
+ "options": [
+ "OverwriteBlobs"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
+ "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
+ "type": "SystemAssigned"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineList.json
new file mode 100644
index 000000000000..506a09edb388
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ExportPipelineList.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "name": "myExportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/exportPipelines",
+ "properties": {
+ "target": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ },
+ "options": [
+ "OverwriteBlobs"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
+ "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
+ "type": "SystemAssigned"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByManifestDigest.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByManifestDigest.json
new file mode 100644
index 000000000000..fdea32166da4
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByManifestDigest.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry",
+ "sourceImage": "sourceRepository@sha256:0000000000000000000000000000000000000000000000000000000000000000"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByTag.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByTag.json
new file mode 100644
index 000000000000..5b34d2cea4fe
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageByTag.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry",
+ "sourceImage": "sourceRepository:sourceTag"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageFromPublicRegistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageFromPublicRegistry.json
new file mode 100644
index 000000000000..eff95a2fa437
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportImageFromPublicRegistry.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "registryUri": "registry.hub.docker.com",
+ "sourceImage": "library/hello-world"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineCreate.json
new file mode 100644
index 000000000000..2983975dc96b
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineCreate.json
@@ -0,0 +1,105 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "importPipelineName": "myImportPipeline",
+ "importPipelineCreateParameters": {
+ "location": "westus",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {}
+ }
+ },
+ "properties": {
+ "source": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "options": [
+ "OverwriteTags",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline",
+ "name": "myImportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/importPipelines",
+ "properties": {
+ "source": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "trigger": {
+ "sourceTrigger": {
+ "status": "Enabled"
+ }
+ },
+ "options": [
+ "OverwriteTags",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
+ "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e",
+ "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline/operationStatuses/importpipelines-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline",
+ "name": "myImportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/importPipelines",
+ "properties": {
+ "source": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "trigger": {
+ "sourceTrigger": {
+ "status": "Enabled"
+ }
+ },
+ "options": [
+ "OverwriteTags",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
+ "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e",
+ "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineDelete.json
new file mode 100644
index 000000000000..d628787accfc
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "importPipelineName": "myImportPipeline"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline/operationStatuses/importpipelines-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineGet.json
new file mode 100644
index 000000000000..7bb34f232f3e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineGet.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "importPipelineName": "myImportPipeline"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline",
+ "name": "myImportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/importPipelines",
+ "properties": {
+ "source": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "trigger": {
+ "sourceTrigger": {
+ "status": "Enabled"
+ }
+ },
+ "options": [
+ "OverwriteTags",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
+ "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e",
+ "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineList.json
new file mode 100644
index 000000000000..cf14d8b08d78
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ImportPipelineList.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline",
+ "name": "myImportPipeline",
+ "type": "Microsoft.ContainerRegistry/registries/importPipelines",
+ "properties": {
+ "source": {
+ "type": "AzureStorageBlobContainer",
+ "uri": "https://accountname.blob.core.windows.net/containername",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "trigger": {
+ "sourceTrigger": {
+ "status": "Enabled"
+ }
+ },
+ "options": [
+ "OverwriteTags",
+ "DeleteSourceBlobOnSuccess",
+ "ContinueOnErrors"
+ ],
+ "provisioningState": "Succeeded"
+ },
+ "location": "westus",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {
+ "clientId": "d3ce1bc2-f7d7-4a5b-9979-950f4e57680e",
+ "principalId": "b6p9f58b-6fbf-4efd-a7e0-fvd46911a466"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/OperationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/OperationList.json
new file mode 100644
index 000000000000..b26f882369d0
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/OperationList.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.ContainerRegistry/locations/deleteVirtualNetworkOrSubnets/action",
+ "display": {
+ "provider": "Microsoft ContainerRegistry",
+ "resource": "",
+ "operation": "Delete virtual network or subnets notifications",
+ "description": "Notifies Microsoft.ContainerRegistry that virtual network or subnet is being deleted"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Export.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Export.json
new file mode 100644
index 000000000000..05e627b8dc37
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Export.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "pipelineRunName": "myPipelineRun",
+ "pipelineRunCreateParameters": {
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "target": {
+ "type": "AzureStorageBlob",
+ "name": "myblob.tar.gz"
+ },
+ "artifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "artifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ]
+ },
+ "response": {
+ "status": "Running",
+ "catalogDigest": "sha256@",
+ "progress": {
+ "percentage": "20"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "target": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ }
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun/operationStatuses/pipelineruns-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "artifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ]
+ },
+ "response": {
+ "status": "Running",
+ "catalogDigest": "sha256@",
+ "progress": {
+ "percentage": "20"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "target": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ }
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Import.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Import.json
new file mode 100644
index 000000000000..7c9f1f0a9363
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunCreate_Import.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "pipelineRunName": "myPipelineRun",
+ "pipelineRunCreateParameters": {
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline",
+ "source": {
+ "type": "AzureStorageBlob",
+ "name": "myblob.tar.gz"
+ },
+ "catalogDigest": "sha256@"
+ },
+ "forceUpdateTag": "2020-03-04T17:23:21.9261521+00:00"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline"
+ },
+ "response": {
+ "status": "Succeeded",
+ "progress": {
+ "percentage": "100"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "importedArtifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ],
+ "source": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "catalogDigest": "sha256@"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun/operationStatuses/pipelineruns-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline"
+ },
+ "response": {
+ "status": "Succeeded",
+ "progress": {
+ "percentage": "100"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "finishTime": "2020-03-04T17:25:21.9261521+00:00",
+ "importedArtifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ],
+ "source": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "catalogDigest": "sha256@"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunDelete.json
new file mode 100644
index 000000000000..9dea64f17f94
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "pipelineRunName": "myPipelineRun"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun/operationStatuses/pipelineruns-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunGet.json
new file mode 100644
index 000000000000..a7b4b0dd9338
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunGet.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "pipelineRunName": "myPipelineRun"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "artifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ]
+ },
+ "response": {
+ "status": "Running",
+ "catalogDigest": "sha256@",
+ "progress": {
+ "percentage": "20"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "target": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ }
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunList.json
new file mode 100644
index 000000000000..08cc3988cd96
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PipelineRunList.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/exportPipelines/myExportPipeline",
+ "artifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ]
+ },
+ "response": {
+ "status": "Running",
+ "catalogDigest": "sha256@",
+ "progress": {
+ "percentage": "20"
+ },
+ "startTime": "2020-03-04T17:23:21.9261521+00:00",
+ "target": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrexportsas"
+ }
+ },
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/pipelineRuns/myPipelineRun",
+ "name": "myPipelineRun",
+ "type": "Microsoft.ContainerRegistry/registries/pipelineRuns",
+ "properties": {
+ "request": {
+ "pipelineResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/importPipelines/myImportPipeline"
+ },
+ "response": {
+ "status": "Succeeded",
+ "progress": {
+ "percentage": "100"
+ },
+ "startTime": "2020-03-03T17:23:21.9261521+00:00",
+ "importedArtifacts": [
+ "sourceRepository/hello-world",
+ "sourceRepository2@sha256:00000000000000000000000000000000000"
+ ],
+ "source": {
+ "type": "AzureStorageBlob",
+ "uri": "https://accountname.blob.core.windows.net/containername/myblob.tar.gz",
+ "keyVaultUri": "https://myvault.vault.azure.net/secrets/acrimportsas"
+ },
+ "catalogDigest": "sha256@"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json
new file mode 100644
index 000000000000..99fc11911817
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionCreateOrUpdate.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection",
+ "privateEndpointConnection": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection/operationStatuses/privateendpointconnections-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionDelete.json
new file mode 100644
index 000000000000..7e307f5a25b1
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection/operationStatuses/privateendpointconnections-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionGet.json
new file mode 100644
index 000000000000..a7554c9d05c5
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionList.json
new file mode 100644
index 000000000000..5d06f8825f83
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/PrivateEndpointConnectionList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameAvailable.json
new file mode 100644
index 000000000000..0c8be44b105b
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameAvailable.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "registryNameCheckRequest": {
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameNotAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameNotAvailable.json
new file mode 100644
index 000000000000..707611050ff5
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCheckNameNotAvailable.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "registryNameCheckRequest": {
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "The registry myRegistry is already in use."
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreate.json
new file mode 100644
index 000000000000..78a039c416c0
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreate.json
@@ -0,0 +1,128 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registry": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "adminUserEnabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Creating",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreateZoneRedundant.json
new file mode 100644
index 000000000000..a2c6501ba653
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryCreateZoneRedundant.json
@@ -0,0 +1,131 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registry": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Enabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Creating",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Enabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryDelete.json
new file mode 100644
index 000000000000..17e5c41650b8
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryDelete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGenerateCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGenerateCredentials.json
new file mode 100644
index 000000000000..8e4ee74fe980
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGenerateCredentials.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "generateCredentialsParameters": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "expiry": "2020-12-31T15:59:59.0707808Z"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myToken",
+ "passwords": [
+ {
+ "expiry": "2020-12-31T15:59:59.0707808Z",
+ "name": "password1",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "expiry": "2020-12-31T15:59:59.0707808Z",
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGet.json
new file mode 100644
index 000000000000..ff41fca21559
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGet.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGetPrivateLinkResource.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGetPrivateLinkResource.json
new file mode 100644
index 000000000000..f4d1ce46c268
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryGetPrivateLinkResource.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "groupName": "registry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry",
+ "name": "registry",
+ "type": "Microsoft.ContainerRegistry/registries/privateLinkResources",
+ "properties": {
+ "groupId": "registry",
+ "requiredMembers": [
+ "registry",
+ "registry_data_myregion"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azurecr.io"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryList.json
new file mode 100644
index 000000000000..3045e4c79d73
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryList.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListByResourceGroup.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListByResourceGroup.json
new file mode 100644
index 000000000000..13def33a7e6e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListByResourceGroup.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListCredentials.json
new file mode 100644
index 000000000000..8e04f1e8b94b
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListCredentials.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myRegistry",
+ "passwords": [
+ {
+ "name": "password",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListPrivateLinkResources.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListPrivateLinkResources.json
new file mode 100644
index 000000000000..0f54b682209a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListPrivateLinkResources.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry",
+ "name": "registry",
+ "type": "Microsoft.ContainerRegistry/registries/privateLinkResources",
+ "properties": {
+ "groupId": "registry",
+ "requiredMembers": [
+ "registry",
+ "registry_data_myregion"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azurecr.io"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListUsages.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListUsages.json
new file mode 100644
index 000000000000..2e01f6398dfa
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryListUsages.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Size",
+ "limit": 107374182400,
+ "currentValue": 12345678,
+ "unit": "Bytes"
+ },
+ {
+ "name": "Webhooks",
+ "limit": 10,
+ "currentValue": 2,
+ "unit": "Count"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryRegenerateCredential.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryRegenerateCredential.json
new file mode 100644
index 000000000000..7fe05e9acaf2
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryRegenerateCredential.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "regenerateCredentialParameters": {
+ "name": "password"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myRegistry",
+ "passwords": [
+ {
+ "name": "password",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryUpdate.json
new file mode 100644
index 000000000000..c6c219039669
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/RegistryUpdate.json
@@ -0,0 +1,130 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registryUpdateParameters": {
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "adminUserEnabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Updating",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled",
+ "anonymousPullEnabled": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreate.json
new file mode 100644
index 000000000000..9f042cf23cf3
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreate.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replication": {
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreateZoneRedundant.json
new file mode 100644
index 000000000000..f0e2d66abc77
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationCreateZoneRedundant.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replication": {
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationDelete.json
new file mode 100644
index 000000000000..ae05c5528440
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationGet.json
new file mode 100644
index 000000000000..e09019d3feaa
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationGet.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationList.json
new file mode 100644
index 000000000000..cd997bd3b02c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationList.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationUpdate.json
new file mode 100644
index 000000000000..097e163622e4
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ReplicationUpdate.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replicationUpdateParameters": {
+ "tags": {
+ "key": "value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Updating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapCreate.json
new file mode 100644
index 000000000000..2c0034c9adc9
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapCreate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap",
+ "scopeMapCreateParameters": {
+ "properties": {
+ "description": "Developer Scopes",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapDelete.json
new file mode 100644
index 000000000000..860d5b8e2bce
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapGet.json
new file mode 100644
index 000000000000..93c680b63b74
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapList.json
new file mode 100644
index 000000000000..fd1b66c5f0e4
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapList.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapUpdate.json
new file mode 100644
index 000000000000..2962e598cf9e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/ScopeMapUpdate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap",
+ "scopeMapUpdateParameters": {
+ "properties": {
+ "description": "Developer Scopes",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenCreate.json
new file mode 100644
index 000000000000..65be99d5cbe3
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenCreate.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken",
+ "tokenCreateParameters": {
+ "properties": {
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7",
+ "expiry": "2020-12-04T15:32:48.0707808Z"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7",
+ "expiry": "2020-12-04T15:32:48.0707808Z"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenDelete.json
new file mode 100644
index 000000000000..71212be488be
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenGet.json
new file mode 100644
index 000000000000..c6d57fd33aec
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenGet.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenList.json
new file mode 100644
index 000000000000..d7438f4b563f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenList.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenUpdate.json
new file mode 100644
index 000000000000..47a59a413175
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/TokenUpdate.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken",
+ "tokenUpdateParameters": {
+ "properties": {
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookCreate.json
new file mode 100644
index 000000000000..b40430355669
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookCreate.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook",
+ "webhookCreateParameters": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ },
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookDelete.json
new file mode 100644
index 000000000000..192cf498b8b9
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGet.json
new file mode 100644
index 000000000000..10c3935d4db2
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGetCallbackConfig.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGetCallbackConfig.json
new file mode 100644
index 000000000000..65871d86484f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookGetCallbackConfig.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookList.json
new file mode 100644
index 000000000000..febe8b822d31
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookList.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookListEvents.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookListEvents.json
new file mode 100644
index 000000000000..7017d2ac9a95
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookListEvents.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "eventRequestMessage": {
+ "content": {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "timestamp": "2017-03-01T23:14:37.0707808Z",
+ "action": "push",
+ "target": {
+ "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
+ "size": 708,
+ "digest": "sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
+ "length": 708,
+ "repository": "hello-world",
+ "url": "http://192.168.100.227:5000/v2/hello-world/manifests/sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
+ "tag": "latest"
+ },
+ "request": {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "addr": "192.168.64.11:42961",
+ "host": "192.168.100.227:5000",
+ "method": "GET",
+ "useragent": "curl/7.38.0"
+ },
+ "actor": {},
+ "source": {
+ "addr": "xtal.local:5000",
+ "instanceID": "00000000-0000-0000-0000-000000000000"
+ }
+ },
+ "headers": {
+ "Content-Type": "application/json",
+ "Content-Length": "719",
+ "Authorization": "******"
+ },
+ "method": "POST",
+ "requestUri": "http://myservice.com",
+ "version": "1.1"
+ },
+ "eventResponseMessage": {
+ "headers": {
+ "Content-Length": "0"
+ },
+ "statusCode": "200",
+ "version": "1.1"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookPing.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookPing.json
new file mode 100644
index 000000000000..a9209911bc13
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookPing.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "00000000-0000-0000-0000-000000000000"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookUpdate.json
new file mode 100644
index 000000000000..ed77ae0c9d6e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2023-01-01-preview/examples/WebhookUpdate.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook",
+ "webhookUpdateParameters": {
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ },
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/containerregistry.json
new file mode 100644
index 000000000000..14784ed3ed9a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/containerregistry.json
@@ -0,0 +1,4471 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "ContainerRegistryManagementClient"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Copies an image to this container registry from the specified container registry.",
+ "operationId": "Registries_ImportImage",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The parameters specifying the image to copy and the source container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ImportImageParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation has completed successfully."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ImportImageByTag": {
+ "$ref": "./examples/ImportImageByTag.json"
+ },
+ "ImportImageByManifestDigest": {
+ "$ref": "./examples/ImportImageByManifestDigest.json"
+ },
+ "ImportImageFromPublicRegistry": {
+ "$ref": "./examples/ImportImageFromPublicRegistry.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.ContainerRegistry/operations": {
+ "get": {
+ "tags": [
+ "Operation"
+ ],
+ "description": "Lists all of the available Azure Container Registry REST API operations.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OperationList": {
+ "$ref": "./examples/OperationList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "Operation"
+ ],
+ "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.",
+ "operationId": "Registries_CheckNameAvailability",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "registryNameCheckRequest",
+ "in": "body",
+ "description": "The object containing information for the availability request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegistryNameCheckRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryNameStatus"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryCheckNameAvailable": {
+ "$ref": "./examples/RegistryCheckNameAvailable.json"
+ },
+ "RegistryCheckNameNotAvailable": {
+ "$ref": "./examples/RegistryCheckNameNotAvailable.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "List all private endpoint connections in a container registry.",
+ "operationId": "PrivateEndpointConnections_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionList": {
+ "$ref": "./examples/PrivateEndpointConnectionList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Get the specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionGet": {
+ "$ref": "./examples/PrivateEndpointConnectionGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Update the state of specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ },
+ {
+ "name": "privateEndpointConnection",
+ "in": "body",
+ "description": "The parameters for creating a private endpoint connection.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionCreateOrUpdate": {
+ "$ref": "./examples/PrivateEndpointConnectionCreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Deletes the specified private endpoint connection associated with the container registry.",
+ "operationId": "PrivateEndpointConnections_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The private endpoint connection does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionDelete": {
+ "$ref": "./examples/PrivateEndpointConnectionDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists all the container registries under the specified subscription.",
+ "operationId": "Registries_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryList": {
+ "$ref": "./examples/RegistryList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists all the container registries under the specified resource group.",
+ "operationId": "Registries_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListByResourceGroup": {
+ "$ref": "./examples/RegistryListByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets the properties of the specified container registry.",
+ "operationId": "Registries_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGet": {
+ "$ref": "./examples/RegistryGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Creates a container registry with the specified parameters.",
+ "operationId": "Registries_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "registry",
+ "in": "body",
+ "description": "The parameters for creating a container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryCreate": {
+ "$ref": "./examples/RegistryCreate.json"
+ },
+ "RegistryCreateZoneRedundant": {
+ "$ref": "./examples/RegistryCreateZoneRedundant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Deletes a container registry.",
+ "operationId": "Registries_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The container registry does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "RegistryDelete": {
+ "$ref": "./examples/RegistryDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Updates a container registry with the specified parameters.",
+ "operationId": "Registries_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "registryUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a container registry.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegistryUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Registry"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryUpdate": {
+ "$ref": "./examples/RegistryUpdate.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.ContainerRegistry/registries/{registryName}/listUsages": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets the quota usages for the specified container registry.",
+ "operationId": "Registries_ListUsages",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the registry usages retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryUsageListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListUsages": {
+ "$ref": "./examples/RegistryListUsages.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists the private link resources for a container registry.",
+ "operationId": "Registries_ListPrivateLinkResources",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the private link resources were retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListPrivateLinkResources": {
+ "$ref": "./examples/RegistryListPrivateLinkResources.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}": {
+ "get": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Gets a private link resource by a specified group name for a container registry.",
+ "operationId": "Registries_GetPrivateLinkResource",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the private link resource was retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGetPrivateLinkResource": {
+ "$ref": "./examples/RegistryGetPrivateLinkResource.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Lists the login credentials for the specified container registry.",
+ "operationId": "Registries_ListCredentials",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the list of credentials retrieved and returned successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListCredentialsResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryListCredentials": {
+ "$ref": "./examples/RegistryListCredentials.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Regenerates one of the login credentials for the specified container registry.",
+ "operationId": "Registries_RegenerateCredential",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "regenerateCredentialParameters",
+ "in": "body",
+ "description": "Specifies name of the password which should be regenerated -- password or password2.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegenerateCredentialParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the specified credential regenerated successfully.",
+ "schema": {
+ "$ref": "#/definitions/RegistryListCredentialsResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryRegenerateCredential": {
+ "$ref": "./examples/RegistryRegenerateCredential.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications": {
+ "get": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Lists all the replications for the specified container registry.",
+ "operationId": "Replications_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ReplicationListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationList": {
+ "$ref": "./examples/ReplicationList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}": {
+ "get": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Gets the properties of the specified replication.",
+ "operationId": "Replications_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationGet": {
+ "$ref": "./examples/ReplicationGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Creates a replication for a container registry with the specified parameters.",
+ "operationId": "Replications_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ },
+ {
+ "name": "replication",
+ "in": "body",
+ "description": "The parameters for creating a replication.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationCreate": {
+ "$ref": "./examples/ReplicationCreate.json"
+ },
+ "ReplicationCreateZoneRedundant": {
+ "$ref": "./examples/ReplicationCreateZoneRedundant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Deletes a replication from a container registry.",
+ "operationId": "Replications_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The replication does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationDelete": {
+ "$ref": "./examples/ReplicationDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Replications"
+ ],
+ "description": "Updates a replication for a container registry with the specified parameters.",
+ "operationId": "Replications_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ReplicationNameParameter"
+ },
+ {
+ "name": "replicationUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a replication.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ReplicationUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Replication"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ReplicationUpdate": {
+ "$ref": "./examples/ReplicationUpdate.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.ContainerRegistry/registries/{registryName}/scopeMaps": {
+ "get": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Lists all the scope maps for the specified container registry.",
+ "operationId": "ScopeMaps_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMapListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapList": {
+ "$ref": "./examples/ScopeMapList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}": {
+ "get": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Gets the properties of the specified scope map.",
+ "operationId": "ScopeMaps_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapGet": {
+ "$ref": "./examples/ScopeMapGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Creates a scope map for a container registry with the specified parameters.",
+ "operationId": "ScopeMaps_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ },
+ {
+ "name": "scopeMapCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a scope map.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapCreate": {
+ "$ref": "./examples/ScopeMapCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Deletes a scope map from a container registry.",
+ "operationId": "ScopeMaps_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The scopemap does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapDelete": {
+ "$ref": "./examples/ScopeMapDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "ScopeMaps"
+ ],
+ "description": "Updates a scope map with the specified parameters.",
+ "operationId": "ScopeMaps_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ScopeMapNameParameter"
+ },
+ {
+ "name": "scopeMapUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a scope map.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopeMapUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/ScopeMap"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ScopeMapUpdate": {
+ "$ref": "./examples/ScopeMapUpdate.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.ContainerRegistry/registries/{registryName}/tokens": {
+ "get": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Lists all the tokens for the specified container registry.",
+ "operationId": "Tokens_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/TokenListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenList": {
+ "$ref": "./examples/TokenList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}": {
+ "get": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Gets the properties of the specified token.",
+ "operationId": "Tokens_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenGet": {
+ "$ref": "./examples/TokenGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Creates a token for a container registry with the specified parameters.",
+ "operationId": "Tokens_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ },
+ {
+ "name": "tokenCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a token.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenCreate": {
+ "$ref": "./examples/TokenCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Deletes a token from a container registry.",
+ "operationId": "Tokens_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The token does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenDelete": {
+ "$ref": "./examples/TokenDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Tokens"
+ ],
+ "description": "Updates a token with the specified parameters.",
+ "operationId": "Tokens_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TokenNameParameter"
+ },
+ {
+ "name": "tokenUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a token.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TokenUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Token"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If any of the input parameters are invalid, 400 (Bad Request) is returned. If the request cannot be processed due to a conflict in the request, 409 (Conflict) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TokenUpdate": {
+ "$ref": "./examples/TokenUpdate.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.ContainerRegistry/registries/{registryName}/generateCredentials": {
+ "post": {
+ "tags": [
+ "Registries"
+ ],
+ "description": "Generate keys for a token of a specified container registry.",
+ "operationId": "Registries_GenerateCredentials",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "name": "generateCredentialsParameters",
+ "in": "body",
+ "description": "The parameters for generating credentials.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenerateCredentialsParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/GenerateCredentialsResult"
+ }
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the resource does not exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegistryGenerateCredentials": {
+ "$ref": "./examples/RegistryGenerateCredentials.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Lists all the webhooks for the specified container registry.",
+ "operationId": "Webhooks_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/WebhookListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookList": {
+ "$ref": "./examples/WebhookList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}": {
+ "get": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Gets the properties of the specified webhook.",
+ "operationId": "Webhooks_Get",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookGet": {
+ "$ref": "./examples/WebhookGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Creates a webhook for a container registry with the specified parameters.",
+ "operationId": "Webhooks_Create",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ },
+ {
+ "name": "webhookCreateParameters",
+ "in": "body",
+ "description": "The parameters for creating a webhook.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WebhookCreateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookCreate": {
+ "$ref": "./examples/WebhookCreate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Deletes a webhook from a container registry.",
+ "operationId": "Webhooks_Delete",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "The webhook does not exist in the subscription."
+ }
+ },
+ "x-ms-examples": {
+ "WebhookDelete": {
+ "$ref": "./examples/WebhookDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ },
+ "patch": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Updates a webhook with the specified parameters.",
+ "operationId": "Webhooks_Update",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ },
+ {
+ "name": "webhookUpdateParameters",
+ "in": "body",
+ "description": "The parameters for updating a webhook.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WebhookUpdateParameters"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/Webhook"
+ },
+ "headers": {
+ "Azure-AsyncOperation": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookUpdate": {
+ "$ref": "./examples/WebhookUpdate.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.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Triggers a ping event to be sent to the webhook.",
+ "operationId": "Webhooks_Ping",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/EventInfo"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookPing": {
+ "$ref": "./examples/WebhookPing.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Lists recent events for the specified webhook.",
+ "operationId": "Webhooks_ListEvents",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/EventListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookListEvents": {
+ "$ref": "./examples/WebhookListEvents.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig": {
+ "post": {
+ "tags": [
+ "Webhooks"
+ ],
+ "description": "Gets the configuration of service URI and custom headers for the webhook.",
+ "operationId": "Webhooks_GetCallbackConfig",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/RegistryNameParameter"
+ },
+ {
+ "$ref": "#/parameters/WebhookNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/CallbackConfig"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "WebhookGetCallbackConfig": {
+ "$ref": "./examples/WebhookGetCallbackConfig.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ImportImageParameters": {
+ "required": [
+ "source"
+ ],
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/ImportSource",
+ "description": "The source of the image."
+ },
+ "targetTags": {
+ "description": "List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "untaggedTargetRepositories": {
+ "description": "List of strings of repository names to do a manifest only copy. No tag will be created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mode": {
+ "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins.",
+ "default": "NoForce",
+ "enum": [
+ "NoForce",
+ "Force"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImportMode",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ImportSource": {
+ "required": [
+ "sourceImage"
+ ],
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The resource identifier of the source Azure Container Registry.",
+ "type": "string"
+ },
+ "registryUri": {
+ "description": "The address of the source registry (e.g. 'mcr.microsoft.com').",
+ "type": "string"
+ },
+ "credentials": {
+ "$ref": "#/definitions/ImportSourceCredentials",
+ "description": "Credentials used when importing from a registry uri."
+ },
+ "sourceImage": {
+ "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').",
+ "type": "string"
+ }
+ }
+ },
+ "ImportSourceCredentials": {
+ "required": [
+ "password"
+ ],
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username to authenticate with the source registry.",
+ "type": "string"
+ },
+ "password": {
+ "description": "The password used to authenticate with the source registry.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "The result of a request to list container registry operations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of container registry operations.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDefinition": {
+ "description": "The definition of a container registry operation.",
+ "type": "object",
+ "properties": {
+ "origin": {
+ "description": "The origin information of the container registry operation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayDefinition",
+ "description": "The display information for the container registry operation."
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationPropertiesDefinition",
+ "description": "The properties information for the container registry operation.",
+ "x-ms-client-flatten": true
+ },
+ "isDataAction": {
+ "description": "This property indicates if the operation is an action or a data action\r\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations",
+ "type": "boolean"
+ }
+ }
+ },
+ "OperationDisplayDefinition": {
+ "description": "The display information for a container registry operation.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The resource provider name: Microsoft.ContainerRegistry.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "The resource on which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The operation that users can perform.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description for the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationPropertiesDefinition": {
+ "description": "The definition of Azure Monitoring properties.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/OperationServiceSpecificationDefinition",
+ "description": "The definition of Azure Monitoring service."
+ }
+ }
+ },
+ "OperationServiceSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring list.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "description": "A list of Azure Monitoring metrics definition.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationMetricSpecificationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "logSpecifications": {
+ "description": "A list of Azure Monitoring log definitions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationLogSpecificationDefinition"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "OperationMetricSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring metric.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Metric name.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Metric display name.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "Metric description.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Metric unit.",
+ "type": "string"
+ },
+ "aggregationType": {
+ "description": "Metric aggregation type.",
+ "type": "string"
+ },
+ "internalMetricName": {
+ "description": "Internal metric name.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationLogSpecificationDefinition": {
+ "description": "The definition of Azure Monitoring log.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Log name.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Log display name.",
+ "type": "string"
+ },
+ "blobDuration": {
+ "description": "Log blob duration.",
+ "type": "string"
+ }
+ }
+ },
+ "RegistryNameCheckRequest": {
+ "description": "A request to check whether a container registry name is available.",
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the container registry.",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "type": "string"
+ },
+ "type": {
+ "description": "The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'.",
+ "enum": [
+ "Microsoft.ContainerRegistry/registries"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContainerRegistryResourceType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "RegistryNameStatus": {
+ "description": "The result of a request to check the availability of a container registry name.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "The value that indicates whether the name is available.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "If any, the reason that the name is not available.",
+ "type": "string"
+ },
+ "message": {
+ "description": "If any, the error message that provides more detail for the reason that the name is not available.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnectionListResult": {
+ "description": "The result of a request to list private endpoint connections for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private endpoint connections.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "An object that represents a private endpoint connection for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties of a private endpoint connection.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SystemData": {
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "properties": {
+ "createdBy": {
+ "description": "The identity that created the resource.",
+ "type": "string"
+ },
+ "createdByType": {
+ "description": "The type of identity that created the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC).",
+ "type": "string"
+ },
+ "lastModifiedBy": {
+ "description": "The identity that last modified the resource.",
+ "type": "string"
+ },
+ "lastModifiedByType": {
+ "description": "The type of identity that last modified the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "lastModifiedByType",
+ "modelAsString": true
+ }
+ },
+ "lastModifiedAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource modification (UTC).",
+ "type": "string"
+ }
+ },
+ "readOnly": true
+ },
+ "PrivateEndpointConnectionProperties": {
+ "description": "The properties of a private endpoint connection.",
+ "type": "object",
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "provisioningState": {
+ "description": "The provisioning state of private endpoint connection resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateEndpoint": {
+ "description": "The Private Endpoint resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "This is private endpoint resource created with Microsoft.Network resource provider.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionState": {
+ "description": "The state of a private link service connection.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The private link service connection status.",
+ "enum": [
+ "Approved",
+ "Pending",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "description": "The description for connection status. For example if connection is rejected it can indicate reason for rejection.",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "A message indicating if changes on the service provider require any updates on the consumer.",
+ "enum": [
+ "None",
+ "Recreate"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ActionsRequired",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RegistryListResult": {
+ "description": "The result of a request to list container registries.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Registry"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of container registries.",
+ "type": "string"
+ }
+ }
+ },
+ "Registry": {
+ "description": "An object that represents a container registry.",
+ "required": [
+ "sku"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the container registry."
+ },
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the container registry."
+ },
+ "properties": {
+ "$ref": "#/definitions/RegistryProperties",
+ "description": "The properties of the container registry.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Sku": {
+ "description": "The SKU of a container registry.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The SKU name of the container registry. Required for registry creation.",
+ "enum": [
+ "Classic",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "description": "The SKU tier based on the SKU name.",
+ "enum": [
+ "Classic",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "IdentityProperties": {
+ "description": "Managed identity for the resource.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal ID of resource identity.",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "The tenant ID of resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The identity type.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserIdentityProperties"
+ }
+ }
+ }
+ },
+ "RegistryProperties": {
+ "description": "The properties of a container registry.",
+ "type": "object",
+ "properties": {
+ "loginServer": {
+ "description": "The URL that can be used to log into the container registry.",
+ "type": "string",
+ "readOnly": true
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of the container registry in ISO8601 format.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the container registry at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "$ref": "#/definitions/Status",
+ "description": "The status of the container registry at the time the operation was called.",
+ "readOnly": true
+ },
+ "adminUserEnabled": {
+ "description": "The value that indicates whether the admin user is enabled.",
+ "default": false,
+ "type": "boolean"
+ },
+ "networkRuleSet": {
+ "$ref": "#/definitions/NetworkRuleSet",
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "$ref": "#/definitions/Policies",
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "$ref": "#/definitions/EncryptionProperty",
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "description": "Enable a single data endpoint per region for serving data.",
+ "type": "boolean"
+ },
+ "dataEndpointHostNames": {
+ "description": "List of host names that will serve data when dataEndpointEnabled is true.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "privateEndpointConnections": {
+ "description": "List of private endpoint connections for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the container registry.",
+ "default": "Enabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
+ "networkRuleBypassOptions": {
+ "description": "Whether to allow trusted Azure services to access a network restricted registry.",
+ "default": "AzureServices",
+ "enum": [
+ "AzureServices",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkRuleBypassOptions",
+ "modelAsString": true
+ }
+ },
+ "zoneRedundancy": {
+ "description": "Whether or not zone redundancy is enabled for this container registry",
+ "default": "Disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ZoneRedundancy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserIdentityProperties": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal id of user assigned identity.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "The client id of user assigned identity.",
+ "type": "string"
+ }
+ }
+ },
+ "Resource": {
+ "description": "An Azure resource.",
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "id": {
+ "description": "The resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "location": {
+ "description": "The location of the resource. This cannot be changed after the resource is created.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "The tags of the resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "systemData": {
+ "$ref": "#/definitions/SystemData",
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "Status": {
+ "description": "The status of an Azure resource at the time the operation was called.",
+ "type": "object",
+ "properties": {
+ "displayStatus": {
+ "description": "The short label for the status.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The detailed message for the status, including alerts and error messages.",
+ "type": "string",
+ "readOnly": true
+ },
+ "timestamp": {
+ "format": "date-time",
+ "description": "The timestamp when the status was changed to the current value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountProperties": {
+ "description": "The properties of a storage account for a container registry. Only applicable to Classic SKU.",
+ "required": [
+ "id"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The resource ID of the storage account.",
+ "type": "string"
+ }
+ }
+ },
+ "NetworkRuleSet": {
+ "description": "The network rule set for a container registry.",
+ "required": [
+ "defaultAction"
+ ],
+ "type": "object",
+ "properties": {
+ "defaultAction": {
+ "description": "The default action of allow or deny when no other rules match.",
+ "default": "Allow",
+ "enum": [
+ "Allow",
+ "Deny"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DefaultAction",
+ "modelAsString": true
+ }
+ },
+ "ipRules": {
+ "description": "The IP ACL rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IPRule"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "Policies": {
+ "description": "The policies for a container registry.",
+ "type": "object",
+ "properties": {
+ "quarantinePolicy": {
+ "$ref": "#/definitions/QuarantinePolicy",
+ "description": "The quarantine policy for a container registry."
+ },
+ "trustPolicy": {
+ "$ref": "#/definitions/TrustPolicy",
+ "description": "The content trust policy for a container registry."
+ },
+ "retentionPolicy": {
+ "$ref": "#/definitions/RetentionPolicy",
+ "description": "The retention policy for a container registry."
+ },
+ "exportPolicy": {
+ "$ref": "#/definitions/ExportPolicy",
+ "description": "The export policy for a container registry."
+ }
+ }
+ },
+ "EncryptionProperty": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the encryption is enabled for container registry.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EncryptionStatus",
+ "modelAsString": true
+ }
+ },
+ "keyVaultProperties": {
+ "$ref": "#/definitions/KeyVaultProperties",
+ "description": "Key vault properties."
+ }
+ }
+ },
+ "PackageType": {
+ "description": "The properties of a package type.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the package type.",
+ "type": "string"
+ },
+ "endpoint": {
+ "description": "The endpoint of the package type.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ProxyResource": {
+ "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.",
+ "properties": {
+ "id": {
+ "description": "The resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "#/definitions/SystemData",
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "IPRule": {
+ "description": "IP rule with specific IP or IP range in CIDR format.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "The action of IP ACL rule.",
+ "default": "Allow",
+ "enum": [
+ "Allow"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Action",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.",
+ "type": "string",
+ "x-ms-client-name": "IPAddressOrRange"
+ }
+ }
+ },
+ "QuarantinePolicy": {
+ "description": "The quarantine policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TrustPolicy": {
+ "description": "The content trust policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of trust policy.",
+ "default": "Notary",
+ "enum": [
+ "Notary"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TrustPolicyType",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RetentionPolicy": {
+ "description": "The retention policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "days": {
+ "format": "int32",
+ "description": "The number of days to retain an untagged manifest after which it gets purged.",
+ "default": 7,
+ "type": "integer"
+ },
+ "lastUpdatedTime": {
+ "format": "date-time",
+ "description": "The timestamp when the policy was last updated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "disabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ExportPolicy": {
+ "description": "The export policy for a container registry.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The value that indicates whether the policy is enabled or not.",
+ "default": "enabled",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ExportPolicyStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KeyVaultProperties": {
+ "type": "object",
+ "properties": {
+ "keyIdentifier": {
+ "description": "Key vault uri to access the encryption key.",
+ "type": "string"
+ },
+ "versionedKeyIdentifier": {
+ "description": "The fully qualified key identifier that includes the version of the key that is actually used for encryption.",
+ "type": "string",
+ "readOnly": true
+ },
+ "identity": {
+ "description": "The client id of the identity which will be used to access key vault.",
+ "type": "string"
+ },
+ "keyRotationEnabled": {
+ "description": "Auto key rotation status for a CMK enabled registry.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "lastKeyRotationTimestamp": {
+ "format": "date-time",
+ "description": "Timestamp of the last successful key rotation.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RegistryUpdateParameters": {
+ "description": "The parameters for updating a container registry.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "The identity of the container registry."
+ },
+ "tags": {
+ "description": "The tags for the container registry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the container registry."
+ },
+ "properties": {
+ "$ref": "#/definitions/RegistryPropertiesUpdateParameters",
+ "description": "The properties that the container registry will be updated with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RegistryPropertiesUpdateParameters": {
+ "description": "The parameters for updating the properties of a container registry.",
+ "type": "object",
+ "properties": {
+ "adminUserEnabled": {
+ "description": "The value that indicates whether the admin user is enabled.",
+ "type": "boolean"
+ },
+ "networkRuleSet": {
+ "$ref": "#/definitions/NetworkRuleSet",
+ "description": "The network rule set for a container registry."
+ },
+ "policies": {
+ "$ref": "#/definitions/Policies",
+ "description": "The policies for a container registry."
+ },
+ "encryption": {
+ "$ref": "#/definitions/EncryptionProperty",
+ "description": "The encryption settings of container registry."
+ },
+ "dataEndpointEnabled": {
+ "description": "Enable a single data endpoint per region for serving data.",
+ "type": "boolean"
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the container registry.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
+ "networkRuleBypassOptions": {
+ "description": "Whether to allow trusted Azure services to access a network restricted registry.",
+ "default": "AzureServices",
+ "enum": [
+ "AzureServices",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkRuleBypassOptions",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RegistryUsageListResult": {
+ "description": "The result of a request to get container registry quota usages.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of container registry quota usages.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RegistryUsage"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "RegistryUsage": {
+ "description": "The quota usage for a container registry.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the usage.",
+ "type": "string"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The limit of the usage.",
+ "type": "integer"
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "The current value of the usage.",
+ "type": "integer"
+ },
+ "unit": {
+ "description": "The unit of measurement.",
+ "enum": [
+ "Count",
+ "Bytes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RegistryUsageUnit",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateLinkResourceListResult": {
+ "description": "The result of a request to list private link resources for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private link resources.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A resource that supports private link capabilities.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The resource type is private link resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "The resource ID.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the resource.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "A resource that supports private link capabilities.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateLinkResourceProperties": {
+ "description": "The properties of a private link resource.",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "The private link resource group id.",
+ "type": "string"
+ },
+ "requiredMembers": {
+ "description": "The private link resource required member names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requiredZoneNames": {
+ "description": "The private link resource Private link DNS zone name.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "RegistryListCredentialsResult": {
+ "description": "The response from the ListCredentials operation.",
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username for a container registry.",
+ "type": "string"
+ },
+ "passwords": {
+ "description": "The list of passwords for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RegistryPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "RegistryPassword": {
+ "description": "The login password for the container registry.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The password name.",
+ "enum": [
+ "password",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PasswordName",
+ "modelAsString": false
+ }
+ },
+ "value": {
+ "description": "The password value.",
+ "type": "string"
+ }
+ }
+ },
+ "RegenerateCredentialParameters": {
+ "description": "The parameters used to regenerate the login credential.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Specifies name of the password which should be regenerated -- password or password2.",
+ "enum": [
+ "password",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PasswordName",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "ReplicationListResult": {
+ "description": "The result of a request to list replications for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Replication"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of replications.",
+ "type": "string"
+ }
+ }
+ },
+ "Replication": {
+ "description": "An object that represents a replication for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ReplicationProperties",
+ "description": "The properties of the replication.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ReplicationProperties": {
+ "description": "The properties of a replication.",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "The provisioning state of the replication at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "$ref": "#/definitions/Status",
+ "description": "The status of the replication at the time the operation was called.",
+ "readOnly": true
+ },
+ "regionEndpointEnabled": {
+ "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.",
+ "default": true,
+ "type": "boolean"
+ },
+ "zoneRedundancy": {
+ "description": "Whether or not zone redundancy is enabled for this container registry replication",
+ "default": "Disabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ZoneRedundancy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ReplicationUpdateParameters": {
+ "description": "The parameters for updating a replication.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the replication.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/ReplicationUpdateParametersProperties",
+ "description": "The parameters for updating a replication's properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ReplicationUpdateParametersProperties": {
+ "type": "object",
+ "properties": {
+ "regionEndpointEnabled": {
+ "description": "Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ScopeMapListResult": {
+ "description": "The result of a request to list scope maps for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ScopeMap"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of scope maps.",
+ "type": "string"
+ }
+ }
+ },
+ "ScopeMap": {
+ "description": "An object that represents a scope map for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ScopeMapProperties",
+ "description": "The properties of the scope map.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ScopeMapProperties": {
+ "description": "The properties of a scope map.",
+ "required": [
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The user friendly description of the scope map.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the scope map. E.g. BuildIn scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "actions": {
+ "description": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ScopeMapUpdateParameters": {
+ "description": "The properties for updating the scope map.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ScopeMapPropertiesUpdateParameters",
+ "description": "The update parameters for scope map properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ScopeMapPropertiesUpdateParameters": {
+ "description": "The update parameters for scope map properties.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The user friendly description of the scope map.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of scope permissions for registry artifacts.\r\nE.g. repositories/repository-name/pull, \r\nrepositories/repository-name/delete",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "TokenListResult": {
+ "description": "The result of a request to list tokens for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Token"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of tokens.",
+ "type": "string"
+ }
+ }
+ },
+ "Token": {
+ "description": "An object that represents a token for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TokenProperties",
+ "description": "The properties of the token.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TokenProperties": {
+ "description": "The properties of a token.",
+ "type": "object",
+ "properties": {
+ "creationDate": {
+ "format": "date-time",
+ "description": "The creation date of scope map.",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the resource.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "scopeMapId": {
+ "description": "The resource ID of the scope map to which the token will be associated with.",
+ "type": "string"
+ },
+ "credentials": {
+ "$ref": "#/definitions/TokenCredentialsProperties",
+ "description": "The credentials that can be used for authenticating the token."
+ },
+ "status": {
+ "description": "The status of the token example enabled or disabled.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TokenCredentialsProperties": {
+ "description": "The properties of the credentials that can be used for authenticating the token.",
+ "type": "object",
+ "properties": {
+ "certificates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenCertificate"
+ },
+ "x-ms-identifiers": [
+ "thumbprint"
+ ]
+ },
+ "passwords": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ActiveDirectoryObject": {
+ "description": "The Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The user/group/application object ID for Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "The tenant ID of user/group/application object Active Directory Object that will be used for authenticating the token of a container registry.",
+ "type": "string"
+ }
+ }
+ },
+ "TokenCertificate": {
+ "description": "The properties of a certificate used for authenticating a token.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "enum": [
+ "certificate1",
+ "certificate2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenCertificateName",
+ "modelAsString": true
+ }
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry datetime of the certificate.",
+ "type": "string"
+ },
+ "thumbprint": {
+ "description": "The thumbprint of the certificate.",
+ "type": "string"
+ },
+ "encodedPemCertificate": {
+ "description": "Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token.",
+ "type": "string"
+ }
+ }
+ },
+ "TokenPassword": {
+ "description": "The password that will be used for authenticating the token of a container registry.",
+ "type": "object",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "description": "The creation datetime of the password.",
+ "type": "string"
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry datetime of the password.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The password name \"password1\" or \"password2\"",
+ "enum": [
+ "password1",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenPasswordName",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "The password value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TokenUpdateParameters": {
+ "description": "The parameters for updating a token.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TokenUpdateProperties",
+ "description": "The properties of the token update parameters.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TokenUpdateProperties": {
+ "description": "The parameters for updating token properties.",
+ "type": "object",
+ "properties": {
+ "scopeMapId": {
+ "description": "The resource ID of the scope map to which the token will be associated with.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the token example enabled or disabled.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenStatus",
+ "modelAsString": true
+ }
+ },
+ "credentials": {
+ "$ref": "#/definitions/TokenCredentialsProperties",
+ "description": "The credentials that can be used for authenticating the token."
+ }
+ }
+ },
+ "GenerateCredentialsParameters": {
+ "description": "The parameters used to generate credentials for a specified token or user of a container registry.",
+ "type": "object",
+ "properties": {
+ "tokenId": {
+ "description": "The resource ID of the token for which credentials have to be generated.",
+ "type": "string"
+ },
+ "expiry": {
+ "format": "date-time",
+ "description": "The expiry date of the generated credentials after which the credentials become invalid.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Specifies name of the password which should be regenerated if any -- password1 or password2.",
+ "enum": [
+ "password1",
+ "password2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TokenPasswordName",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "GenerateCredentialsResult": {
+ "description": "The response from the GenerateCredentials operation.",
+ "type": "object",
+ "properties": {
+ "username": {
+ "description": "The username for a container registry.",
+ "type": "string"
+ },
+ "passwords": {
+ "description": "The list of passwords for a container registry.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TokenPassword"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "WebhookListResult": {
+ "description": "The result of a request to list webhooks for a container registry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Webhook"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of webhooks.",
+ "type": "string"
+ }
+ }
+ },
+ "Webhook": {
+ "description": "An object that represents a webhook for a container registry.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/WebhookProperties",
+ "description": "The properties of the webhook.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookProperties": {
+ "description": "The properties of a webhook.",
+ "required": [
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ },
+ "provisioningState": {
+ "description": "The provisioning state of the webhook at the time the operation was called.",
+ "enum": [
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "WebhookCreateParameters": {
+ "description": "The parameters for creating a webhook.",
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the webhook.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "location": {
+ "description": "The location of the webhook. This cannot be changed after the resource is created.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/WebhookPropertiesCreateParameters",
+ "description": "The properties that the webhook will be created with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookPropertiesCreateParameters": {
+ "description": "The parameters for creating the properties of a webhook.",
+ "required": [
+ "serviceUri",
+ "actions"
+ ],
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-secret": true
+ },
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "WebhookUpdateParameters": {
+ "description": "The parameters for updating a webhook.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags for the webhook.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/WebhookPropertiesUpdateParameters",
+ "description": "The properties that the webhook will be updated with.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebhookPropertiesUpdateParameters": {
+ "description": "The parameters for updating the properties of a webhook.",
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-secret": true
+ },
+ "status": {
+ "description": "The status of the webhook at the time the operation was called.",
+ "enum": [
+ "enabled",
+ "disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookStatus",
+ "modelAsString": true
+ }
+ },
+ "scope": {
+ "description": "The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.",
+ "type": "string"
+ },
+ "actions": {
+ "description": "The list of actions that trigger the webhook to post notifications.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "push",
+ "delete",
+ "quarantine",
+ "chart_push",
+ "chart_delete"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebhookAction",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "EventInfo": {
+ "description": "The basic information of an event.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The event ID.",
+ "type": "string"
+ }
+ }
+ },
+ "EventListResult": {
+ "description": "The result of a request to list events for a webhook.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Event"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of events.",
+ "type": "string"
+ }
+ }
+ },
+ "Event": {
+ "description": "The event for a webhook.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/EventInfo"
+ }
+ ],
+ "properties": {
+ "eventRequestMessage": {
+ "$ref": "#/definitions/EventRequestMessage",
+ "description": "The event request message sent to the service URI."
+ },
+ "eventResponseMessage": {
+ "$ref": "#/definitions/EventResponseMessage",
+ "description": "The event response message received from the service URI."
+ }
+ }
+ },
+ "EventRequestMessage": {
+ "description": "The event request message sent to the service URI.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "$ref": "#/definitions/EventContent",
+ "description": "The content of the event request message."
+ },
+ "headers": {
+ "description": "The headers of the event request message.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "method": {
+ "description": "The HTTP method used to send the event request message.",
+ "type": "string"
+ },
+ "requestUri": {
+ "description": "The URI used to send the event request message.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The HTTP message version.",
+ "type": "string"
+ }
+ }
+ },
+ "EventResponseMessage": {
+ "description": "The event response message received from the service URI.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The content of the event response message.",
+ "type": "string"
+ },
+ "headers": {
+ "description": "The headers of the event response message.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "reasonPhrase": {
+ "description": "The reason phrase of the event response message.",
+ "type": "string"
+ },
+ "statusCode": {
+ "description": "The status code of the event response message.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The HTTP message version.",
+ "type": "string"
+ }
+ }
+ },
+ "EventContent": {
+ "description": "The content of the event request message.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The event ID.",
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "date-time",
+ "description": "The time at which the event occurred.",
+ "type": "string"
+ },
+ "action": {
+ "description": "The action that encompasses the provided event.",
+ "type": "string"
+ },
+ "target": {
+ "$ref": "#/definitions/Target",
+ "description": "The target of the event."
+ },
+ "request": {
+ "$ref": "#/definitions/Request",
+ "description": "The request that generated the event."
+ },
+ "actor": {
+ "$ref": "#/definitions/Actor",
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request."
+ },
+ "source": {
+ "$ref": "#/definitions/Source",
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it."
+ }
+ }
+ },
+ "Target": {
+ "description": "The target of the event.",
+ "type": "object",
+ "properties": {
+ "mediaType": {
+ "description": "The MIME type of the referenced object.",
+ "type": "string"
+ },
+ "size": {
+ "format": "int64",
+ "description": "The number of bytes of the content. Same as Length field.",
+ "type": "integer"
+ },
+ "digest": {
+ "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification.",
+ "type": "string"
+ },
+ "length": {
+ "format": "int64",
+ "description": "The number of bytes of the content. Same as Size field.",
+ "type": "integer"
+ },
+ "repository": {
+ "description": "The repository name.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The direct URL to the content.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "The tag name.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the artifact.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the artifact.",
+ "type": "string"
+ }
+ }
+ },
+ "Request": {
+ "description": "The request that generated the event.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The ID of the request that initiated the event.",
+ "type": "string"
+ },
+ "addr": {
+ "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request.",
+ "type": "string"
+ },
+ "host": {
+ "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.",
+ "type": "string"
+ },
+ "method": {
+ "description": "The request method that generated the event.",
+ "type": "string"
+ },
+ "useragent": {
+ "description": "The user agent header of the request.",
+ "type": "string"
+ }
+ }
+ },
+ "Actor": {
+ "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The subject or username associated with the request context that generated the event.",
+ "type": "string"
+ }
+ }
+ },
+ "Source": {
+ "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.",
+ "type": "object",
+ "properties": {
+ "addr": {
+ "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.",
+ "type": "string"
+ },
+ "instanceID": {
+ "description": "The running instance of an application. Changes after each restart.",
+ "type": "string"
+ }
+ }
+ },
+ "CallbackConfig": {
+ "description": "The configuration of service URI and custom headers for the webhook.",
+ "required": [
+ "serviceUri"
+ ],
+ "type": "object",
+ "properties": {
+ "serviceUri": {
+ "description": "The service URI for the webhook to post notifications.",
+ "type": "string"
+ },
+ "customHeaders": {
+ "description": "Custom headers that will be added to the webhook notifications.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "An error response from the Azure Container Registry service.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorResponseBody",
+ "description": "Azure container registry build API error body."
+ }
+ }
+ },
+ "ErrorResponseBody": {
+ "description": "An error response from the Azure Container Registry service.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "properties": {
+ "code": {
+ "description": "error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "target of the particular error.",
+ "type": "string"
+ },
+ "details": {
+ "description": "an array of additional nested error response info objects, as described by this contract.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InnerErrorDescription"
+ },
+ "x-ms-identifiers": [
+ "message",
+ "target"
+ ]
+ }
+ }
+ },
+ "InnerErrorDescription": {
+ "description": "inner error.",
+ "required": [
+ "code",
+ "message"
+ ],
+ "properties": {
+ "code": {
+ "description": "error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "target of the particular error.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "RegistryNameParameter": {
+ "name": "registryName",
+ "in": "path",
+ "description": "The name of the container registry.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "WebhookNameParameter": {
+ "name": "webhookName",
+ "in": "path",
+ "description": "The name of the webhook.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ReplicationNameParameter": {
+ "name": "replicationName",
+ "in": "path",
+ "description": "The name of the replication.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "ScopeMapNameParameter": {
+ "name": "scopeMapName",
+ "in": "path",
+ "description": "The name of the scope map.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-_]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "TokenNameParameter": {
+ "name": "tokenName",
+ "in": "path",
+ "description": "The name of the token.",
+ "required": true,
+ "type": "string",
+ "maxLength": 50,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9-]*$",
+ "x-ms-parameter-location": "method"
+ },
+ "PrivateEndpointConnectionNameParameter": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "description": "The name of the private endpoint connection.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "GroupNameParameter": {
+ "name": "groupName",
+ "in": "path",
+ "description": "The name of the private link resource.",
+ "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"
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByManifestDigest.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByManifestDigest.json
new file mode 100644
index 000000000000..6d147d9729ab
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByManifestDigest.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry",
+ "sourceImage": "sourceRepository@sha256:0000000000000000000000000000000000000000000000000000000000000000"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByTag.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByTag.json
new file mode 100644
index 000000000000..56b0bbd048bd
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageByTag.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry",
+ "sourceImage": "sourceRepository:sourceTag"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageFromPublicRegistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageFromPublicRegistry.json
new file mode 100644
index 000000000000..ae8f3962111e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ImportImageFromPublicRegistry.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "parameters": {
+ "source": {
+ "registryUri": "registry.hub.docker.com",
+ "sourceImage": "library/hello-world"
+ },
+ "targetTags": [
+ "targetRepository:targetTag"
+ ],
+ "untaggedTargetRepositories": [
+ "targetRepository1"
+ ],
+ "mode": "Force"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/locations/location/operationResults/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/OperationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/OperationList.json
new file mode 100644
index 000000000000..a0e1825a2758
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/OperationList.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.ContainerRegistry/locations/deleteVirtualNetworkOrSubnets/action",
+ "display": {
+ "provider": "Microsoft ContainerRegistry",
+ "resource": "",
+ "operation": "Delete virtual network or subnets notifications",
+ "description": "Notifies Microsoft.ContainerRegistry that virtual network or subnet is being deleted"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionCreateOrUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionCreateOrUpdate.json
new file mode 100644
index 000000000000..b462809733a6
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionCreateOrUpdate.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection",
+ "privateEndpointConnection": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection/operationStatuses/privateendpointconnections-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionDelete.json
new file mode 100644
index 000000000000..af20bdc25869
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection/operationStatuses/privateendpointconnections-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionGet.json
new file mode 100644
index 000000000000..889edda2384b
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "privateEndpointConnectionName": "myConnection"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionList.json
new file mode 100644
index 000000000000..35199cc617c1
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/PrivateEndpointConnectionList.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateEndpointConnections/myConnection",
+ "name": "myConnection",
+ "type": "Microsoft.ContainerRegistry/registries/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameAvailable.json
new file mode 100644
index 000000000000..769b21246616
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameAvailable.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "registryNameCheckRequest": {
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameNotAvailable.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameNotAvailable.json
new file mode 100644
index 000000000000..72254498bf32
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCheckNameNotAvailable.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "registryNameCheckRequest": {
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "The registry myRegistry is already in use."
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreate.json
new file mode 100644
index 000000000000..25c432c353c6
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreate.json
@@ -0,0 +1,126 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registry": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "adminUserEnabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Creating",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreateZoneRedundant.json
new file mode 100644
index 000000000000..61d55f91459c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryCreateZoneRedundant.json
@@ -0,0 +1,129 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registry": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Creating",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryDelete.json
new file mode 100644
index 000000000000..73abcfbfac3f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryDelete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGenerateCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGenerateCredentials.json
new file mode 100644
index 000000000000..3631a21f2cbc
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGenerateCredentials.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "generateCredentialsParameters": {
+ "tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "expiry": "2020-12-31T15:59:59.0707808Z"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myToken",
+ "passwords": [
+ {
+ "expiry": "2020-12-31T15:59:59.0707808Z",
+ "name": "password1",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "expiry": "2020-12-31T15:59:59.0707808Z",
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGet.json
new file mode 100644
index 000000000000..b79da325f99f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGet.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGetPrivateLinkResource.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGetPrivateLinkResource.json
new file mode 100644
index 000000000000..9351eac8b7ef
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryGetPrivateLinkResource.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "groupName": "registry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry",
+ "name": "registry",
+ "type": "Microsoft.ContainerRegistry/registries/privateLinkResources",
+ "properties": {
+ "groupId": "registry",
+ "requiredMembers": [
+ "registry",
+ "registry_data_myregion"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azurecr.io"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryList.json
new file mode 100644
index 000000000000..c74e42f59745
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryList.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListByResourceGroup.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListByResourceGroup.json
new file mode 100644
index 000000000000..6a010a64d094
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListByResourceGroup.json
@@ -0,0 +1,65 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": false,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListCredentials.json
new file mode 100644
index 000000000000..7cc769b8be0a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListCredentials.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myRegistry",
+ "passwords": [
+ {
+ "name": "password",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListPrivateLinkResources.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListPrivateLinkResources.json
new file mode 100644
index 000000000000..cac54342fc3d
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListPrivateLinkResources.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/privateLinkResources/registry",
+ "name": "registry",
+ "type": "Microsoft.ContainerRegistry/registries/privateLinkResources",
+ "properties": {
+ "groupId": "registry",
+ "requiredMembers": [
+ "registry",
+ "registry_data_myregion"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azurecr.io"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListUsages.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListUsages.json
new file mode 100644
index 000000000000..f5afb7f0a418
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryListUsages.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Size",
+ "limit": 107374182400,
+ "currentValue": 12345678,
+ "unit": "Bytes"
+ },
+ {
+ "name": "Webhooks",
+ "limit": 10,
+ "currentValue": 2,
+ "unit": "Count"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryRegenerateCredential.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryRegenerateCredential.json
new file mode 100644
index 000000000000..d2a79954f2c9
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryRegenerateCredential.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "regenerateCredentialParameters": {
+ "name": "password"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "username": "myRegistry",
+ "passwords": [
+ {
+ "name": "password",
+ "value": "00000000000000000000000000000000"
+ },
+ {
+ "name": "password2",
+ "value": "00000000000000000000000000000000"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryUpdate.json
new file mode 100644
index 000000000000..d5c7b213d2b5
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/RegistryUpdate.json
@@ -0,0 +1,128 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "registryUpdateParameters": {
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard"
+ },
+ "properties": {
+ "adminUserEnabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Succeeded",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
+ "name": "myRegistry",
+ "type": "Microsoft.ContainerRegistry/registries",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "sku": {
+ "name": "Standard",
+ "tier": "Standard"
+ },
+ "properties": {
+ "loginServer": "myRegistry.azurecr-test.io",
+ "creationDate": "2021-06-15T21:38:26.1537861Z",
+ "provisioningState": "Updating",
+ "adminUserEnabled": true,
+ "networkRuleSet": {
+ "defaultAction": "Allow",
+ "ipRules": []
+ },
+ "policies": {
+ "quarantinePolicy": {
+ "status": "disabled"
+ },
+ "trustPolicy": {
+ "type": "Notary",
+ "status": "disabled"
+ },
+ "retentionPolicy": {
+ "days": 7,
+ "lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
+ "status": "disabled"
+ },
+ "exportPolicy": {
+ "status": "enabled"
+ }
+ },
+ "encryption": {
+ "status": "disabled"
+ },
+ "status": null,
+ "dataEndpointEnabled": false,
+ "dataEndpointHostNames": [],
+ "privateEndpointConnections": [],
+ "publicNetworkAccess": "Enabled",
+ "networkRuleBypassOptions": "AzureServices",
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreate.json
new file mode 100644
index 000000000000..99618d2b1937
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreate.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replication": {
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreateZoneRedundant.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreateZoneRedundant.json
new file mode 100644
index 000000000000..253a2c9d7ecd
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationCreateZoneRedundant.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replication": {
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Creating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Enabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationDelete.json
new file mode 100644
index 000000000000..0eef8d650c7a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationGet.json
new file mode 100644
index 000000000000..8a9291f872bb
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationGet.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationList.json
new file mode 100644
index 000000000000..d0c8da9f0fc7
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationList.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationUpdate.json
new file mode 100644
index 000000000000..3231d591f94e
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ReplicationUpdate.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "replicationName": "myReplication",
+ "replicationUpdateParameters": {
+ "tags": {
+ "key": "value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "status": {
+ "displayStatus": "Ready",
+ "message": "The replication is ready.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication/operationStatuses/replications-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/replications/myReplication",
+ "name": "myReplication",
+ "type": "Microsoft.ContainerRegistry/registries/replications",
+ "location": "eastus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "provisioningState": "Updating",
+ "status": {
+ "displayStatus": "Provisioning",
+ "message": "The replication is provisioning.",
+ "timestamp": "2017-03-01T23:15:37.0707808Z"
+ },
+ "regionEndpointEnabled": true,
+ "zoneRedundancy": "Disabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapCreate.json
new file mode 100644
index 000000000000..c8108832ae16
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapCreate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap",
+ "scopeMapCreateParameters": {
+ "properties": {
+ "description": "Developer Scopes",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapDelete.json
new file mode 100644
index 000000000000..0d712c56e56a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapGet.json
new file mode 100644
index 000000000000..927a25b5732f
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapList.json
new file mode 100644
index 000000000000..a3010a83b30c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapList.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/delete"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapUpdate.json
new file mode 100644
index 000000000000..649bcadf9cf9
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/ScopeMapUpdate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "scopeMapName": "myScopeMap",
+ "scopeMapUpdateParameters": {
+ "properties": {
+ "description": "Developer Scopes",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap/operationStatuses/scopemaps-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "name": "myScopeMap",
+ "type": "Microsoft.ContainerRegistry/registries/scopeMaps",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "type": "IsUserDefined",
+ "actions": [
+ "repositories/myrepository/contentWrite",
+ "repositories/myrepository/contentRead"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenCreate.json
new file mode 100644
index 000000000000..dc330537e3e1
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenCreate.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken",
+ "tokenCreateParameters": {
+ "properties": {
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7",
+ "expiry": "2020-12-04T15:32:48.0707808Z"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "disabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "thumbprint": "feeb79a888bf1415f8e17c4965a2a5bb5c8a2ff7",
+ "expiry": "2020-12-04T15:32:48.0707808Z"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenDelete.json
new file mode 100644
index 000000000000..849233274177
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenGet.json
new file mode 100644
index 000000000000..4b00ab4a8924
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenGet.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenList.json
new file mode 100644
index 000000000000..b714abbb3779
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenList.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenUpdate.json
new file mode 100644
index 000000000000..70766f61e99b
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/TokenUpdate.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "tokenName": "myToken",
+ "tokenUpdateParameters": {
+ "properties": {
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken/operationStatuses/tokens-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/myToken",
+ "name": "myToken",
+ "type": "Microsoft.ContainerRegistry/registries/tokens",
+ "properties": {
+ "creationDate": "2017-03-01T23:14:37.0707808Z",
+ "scopeMapId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scopeMaps/myNewScopeMap",
+ "provisioningState": "Succeeded",
+ "status": "enabled",
+ "credentials": {
+ "certificates": [
+ {
+ "name": "certificate1",
+ "encodedPemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUc3akNDQk5hZ0F3SUJBZ0lURmdBQlR3UVpyZGdmdmhxdzBnQUFBQUZQQkRBTkJna3Foa2lHOXcwQkFRc0YKQURDQml6RUxNQWtHQTFVRUJoTUNWVk14RXpBUkJnTlZCQWdUQ2xkaGMyaHBibWQwYjI0eEVEQU9CZ05WQkFjVApCMUpsWkcxdmJtUXhIakFjQmdOVkJBb1RGVTFwWTNKdmMyOW1kQ0JEYjNKd2IzSmhkR2x2YmpFVk1CTUdBMVVFCkN4TU1UV2xqY205emIyWjBJRWxVTVI0d0hBWURWUVFERXhWTmFXTnliM052Wm5RZ1NWUWdWRXhUSUVOQklEUXcKSGhjTk1UZ3dOREV5TWpJek1qUTRXaGNOTWpBd05ERXlNakl6TWpRNFdqQTVNVGN3TlFZRFZRUURFeTV6WlhKMgphV05sWTJ4cFpXNTBZMlZ5ZEMxd1lYSjBibVZ5TG0xaGJtRm5aVzFsYm5RdVlYcDFjbVV1WTI5dE1JSUJJakFOCkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQTBSYjdJcHpxMmR4emhhbVpyS1ZDakMzeTQyYlYKUnNIY2pCUTFuSDBHZ1puUDhXeDZDSE1mWThybkVJQzRLeVRRYkJXVzhnNXlmc3NSQ0ZXbFpxYjR6SkRXS0pmTgpGSmNMUm9LNnhwTktZYVZVTkVlT25IdUxHYTM0ZlA0VjBFRjZybzdvbkRLME5zanhjY1dZVzRNVXVzc0xrQS94CkUrM2RwU1REdk1KcjJoWUpsVnFDcVR6blQvbmZaVUZzQUVEQnp5MUpOOHZiZDlIR2czc2Myd0x4dk95cFJOc0gKT1V3V2pmN2xzWWZleEVlcWkzY29EeHc2alpLVWEyVkdsUnBpTkowMjhBQitYSi9TU1FVNVBsd0JBbU9TT3ovRApGY0NKdGpPZlBqU1NKckFIQVV3SHU3RzlSV05JTFBwYU9zQ1J5eitETE5zNGpvNlEvUUg4d1lManJRSURBUUFCCm80SUNtakNDQXBZd0N3WURWUjBQQkFRREFnU3dNQjBHQTFVZEpRUVdNQlFHQ0NzR0FRVUZCd01DQmdnckJnRUYKQlFjREFUQWRCZ05WSFE0RUZnUVVlbEdkVVJrZzJoSFFOWEQ4WUc4L3drdjJVT0F3SHdZRFZSMGpCQmd3Rm9BVQplbnVNd2Mvbm9Nb2MxR3Y2KytFend3OGFvcDB3Z2F3R0ExVWRId1NCcERDQm9UQ0JucUNCbTZDQm1JWkxhSFIwCmNEb3ZMMjF6WTNKc0xtMXBZM0p2YzI5bWRDNWpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjAKSlRJd1NWUWxNakJVVEZNbE1qQkRRU1V5TURRdVkzSnNoa2xvZEhSd09pOHZZM0pzTG0xcFkzSnZjMjltZEM1agpiMjB2Y0d0cEwyMXpZMjl5Y0M5amNtd3ZUV2xqY205emIyWjBKVEl3U1ZRbE1qQlVURk1sTWpCRFFTVXlNRFF1ClkzSnNNSUdGQmdnckJnRUZCUWNCQVFSNU1IY3dVUVlJS3dZQkJRVUhNQUtHUldoMGRIQTZMeTkzZDNjdWJXbGoKY205emIyWjBMbU52YlM5d2Eya3ZiWE5qYjNKd0wwMXBZM0p2YzI5bWRDVXlNRWxVSlRJd1ZFeFRKVEl3UTBFbApNakEwTG1OeWREQWlCZ2dyQmdFRkJRY3dBWVlXYUhSMGNEb3ZMMjlqYzNBdWJYTnZZM053TG1OdmJUQStCZ2tyCkJnRUVBWUkzRlFjRU1UQXZCaWNyQmdFRUFZSTNGUWlIMm9aMWcrN1pBWUxKaFJ1QnRaNWhoZlRyWUlGZGhOTGYKUW9Mbmszb0NBV1FDQVIwd1RRWURWUjBnQkVZd1JEQkNCZ2tyQmdFRUFZSTNLZ0V3TlRBekJnZ3JCZ0VGQlFjQwpBUlluYUhSMGNEb3ZMM2QzZHk1dGFXTnliM052Wm5RdVkyOXRMM0JyYVM5dGMyTnZjbkF2WTNCek1DY0dDU3NHCkFRUUJnamNWQ2dRYU1CZ3dDZ1lJS3dZQkJRVUhBd0l3Q2dZSUt3WUJCUVVIQXdFd09RWURWUjBSQkRJd01JSXUKYzJWeWRtbGpaV05zYVdWdWRHTmxjblF0Y0dGeWRHNWxjaTV0WVc1aFoyVnRaVzUwTG1GNmRYSmxMbU52YlRBTgpCZ2txaGtpRzl3MEJBUXNGQUFPQ0FnRUFIVXIzbk1vdUI5WWdDUlRWYndUTllIS2RkWGJkSW1GUXNDYys4T1g1CjE5c0N6dFFSR05iSXEwVW1Ba01MbFVvWTIxckh4ZXdxU2hWczFhL2RwaFh5Tk1pcUdaU2QzU1BtYzZscitqUFQKNXVEREs0MUlWeXN0K2VUNlpyazFvcCtMVmdkeS9EU2lyNzVqcWZFY016bS82bU8rNnFNeWRLTWtVYmM5K3JHVwphUkpUcjRWUUdIRmEwNEIwZVZpNUd4MG9pL2RpZDNSaXg2aXJMMjFJSGEwYjN6c1hzZHpHU0R2K3hqL2Q2S0l4Ckdrd2FhYmZvU1NoQnFqaFNlQ0VyZXFlb1RpYjljdGw0MGRVdUp3THl4bjhHS2N6K3AvMEJUOEIxU3lYK01OQ2wKY0pkMjVtMjhLajY2TGUxOEVyeFlJYXZJVGVGa3Y2eGZjdkEvcHladDdPaU41QTlGQk1IUmpQK1kyZ2tvdjMrcQpISFRUZG4xNnlRajduNit3YlFHNGVleXc0YisyQkRLcUxNVFU2ZmlSQ3ZPM2FPZVBLSFVNN3R4b1FidWl6Z3NzCkNiMzl3QnJOTEZsMkJLQ1RkSCtkSU9oZVJiSkZvbmlwOGRPOUVFZWdSSG9lQW54ZUlYTFBrdXMzTzEvZjRhNkIKWHQ3RG5BUm8xSzJmeEp3VXRaU2MvR3dFSjU5NzlnRXlEa3pDZEVsLzdpWE9QZXVjTXhlM2xVM2pweUtsNERUaApjSkJqQytqNGpLWTFrK1U4b040aGdqYnJISUx6Vnd2eU15OU5KS290U3BMSjQxeHdPOHlGangxalFTT3Bxc0N1ClFhUFUvTjhSZ0hxWjBGTkFzS3dNUmZ6WmdXanRCNzRzYUVEdk5jVmNuNFhCQnFNSG0ydHo2Uzk3d3kxZGt0cTgKSE5BPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg=="
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookCreate.json
new file mode 100644
index 000000000000..6a82a1512e87
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookCreate.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook",
+ "webhookCreateParameters": {
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ },
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Creating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookDelete.json
new file mode 100644
index 000000000000..f3c416f68013
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGet.json
new file mode 100644
index 000000000000..707627a55baa
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGetCallbackConfig.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGetCallbackConfig.json
new file mode 100644
index 000000000000..560a85df804c
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookGetCallbackConfig.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookList.json
new file mode 100644
index 000000000000..ce14190aa37a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookList.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookListEvents.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookListEvents.json
new file mode 100644
index 000000000000..94cdd6928739
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookListEvents.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "eventRequestMessage": {
+ "content": {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "timestamp": "2017-03-01T23:14:37.0707808Z",
+ "action": "push",
+ "target": {
+ "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
+ "size": 708,
+ "digest": "sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
+ "length": 708,
+ "repository": "hello-world",
+ "url": "http://192.168.100.227:5000/v2/hello-world/manifests/sha256:fea8895f450959fa676bcc1df0611ea93823a735a01205fd8622846041d0c7cf",
+ "tag": "latest"
+ },
+ "request": {
+ "id": "00000000-0000-0000-0000-000000000000",
+ "addr": "192.168.64.11:42961",
+ "host": "192.168.100.227:5000",
+ "method": "GET",
+ "useragent": "curl/7.38.0"
+ },
+ "actor": {},
+ "source": {
+ "addr": "xtal.local:5000",
+ "instanceID": "00000000-0000-0000-0000-000000000000"
+ }
+ },
+ "headers": {
+ "Content-Type": "application/json",
+ "Content-Length": "719",
+ "Authorization": "******"
+ },
+ "method": "POST",
+ "requestUri": "http://myservice.com",
+ "version": "1.1"
+ },
+ "eventResponseMessage": {
+ "headers": {
+ "Content-Length": "0"
+ },
+ "statusCode": "200",
+ "version": "1.1"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookPing.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookPing.json
new file mode 100644
index 000000000000..1942f06b8865
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookPing.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "00000000-0000-0000-0000-000000000000"
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookUpdate.json
new file mode 100644
index 000000000000..345ded37a72a
--- /dev/null
+++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2022-12-01/examples/WebhookUpdate.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "myResourceGroup",
+ "registryName": "myRegistry",
+ "webhookName": "myWebhook",
+ "webhookUpdateParameters": {
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "serviceUri": "http://myservice.com",
+ "customHeaders": {
+ "Authorization": "Basic 000000000000000000000000000000000000000000000000000"
+ },
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook/operationStatuses/webhooks-00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ },
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/webhooks/myWebhook",
+ "name": "myWebhook",
+ "type": "Microsoft.ContainerRegistry/registries/webhooks",
+ "location": "westus",
+ "tags": {
+ "key": "value"
+ },
+ "properties": {
+ "status": "enabled",
+ "scope": "myRepository",
+ "actions": [
+ "push"
+ ],
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerregistry/resource-manager/readme.go.md b/specification/containerregistry/resource-manager/readme.go.md
index 18cfde0ae16f..9f195c74de1f 100644
--- a/specification/containerregistry/resource-manager/readme.go.md
+++ b/specification/containerregistry/resource-manager/readme.go.md
@@ -21,6 +21,8 @@ go:
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2023-01-preview
+ - tag: package-2022-12
- tag: package-2022-02-preview
- tag: package-2021-12-preview
- tag: package-2021-09
@@ -39,6 +41,24 @@ batch:
- tag: package-2016-06-preview
```
+### Tag: package-2023-01-preview and go
+
+These settings apply only when `--tag=package-2023-01-preview --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2023-01-preview' && $(go)
+output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-01-01-preview/$(namespace)
+```
+
+### Tag: package-2022-12 and go
+
+These settings apply only when `--tag=package-2022-12 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2022-12' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-12-01/$(namespace)
+```
+
### Tag: package-2022-02-preview and go
These settings apply only when `--tag=package-2022-02-preview --go` is specified on the command line.
diff --git a/specification/containerregistry/resource-manager/readme.java.md b/specification/containerregistry/resource-manager/readme.java.md
index eaac0e56ccd4..c68b5b5d9bb9 100644
--- a/specification/containerregistry/resource-manager/readme.java.md
+++ b/specification/containerregistry/resource-manager/readme.java.md
@@ -25,6 +25,8 @@ directive:
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2023-01-preview
+ - tag: package-2022-12
- tag: package-2022-02-preview
- tag: package-2021-12-preview
- tag: package-2021-09
@@ -43,6 +45,32 @@ batch:
- tag: package-2016-06-preview
```
+### Tag: package-2023-01-preview and java
+
+These settings apply only when `--tag=package-2023-01-preview --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2023-01-preview' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.containerregistry.v2023_01_01_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/containerregistry/mgmt-v2023_01_01_preview
+regenerate-manager: true
+generate-interface: true
+```
+
+### Tag: package-2022-12 and java
+
+These settings apply only when `--tag=package-2022-12 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2022-12' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.containerregistry.v2022_12_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/containerregistry/mgmt-v2022_12_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2022-02-preview and java
These settings apply only when `--tag=package-2022-02-preview --java` is specified on the command line.
diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md
index 35d253f8403c..0ca4fc079bac 100644
--- a/specification/containerregistry/resource-manager/readme.md
+++ b/specification/containerregistry/resource-manager/readme.md
@@ -26,14 +26,52 @@ These are the global settings for the ContainerRegistry API.
``` yaml
openapi-type: arm
-tag: package-2022-02-preview
+tag: package-2023-01-preview
+```
+
+### Tag: package-2023-01-preview-only
+
+These settings apply only when `--tag=package-2023-01-preview-only` is specified on the command line.
+
+```yaml $(tag) == 'package-2023-01-preview-only'
+input-file:
+ - Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
+```
+
+### Tag: package-2023-01-preview
+
+These settings apply only when `--tag=package-2023-01-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2023-01-preview'
+input-file:
+ - Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
+ - Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json
+ ```
+
+### Tag: package-2022-12-only
+
+These settings apply only when `--tag=package-2022-12-only` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12-only'
+input-file:
+ - Microsoft.ContainerRegistry/stable/2022-12-01/containerregistry.json
+```
+
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.ContainerRegistry/stable/2022-12-01/containerregistry.json
+ - Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json
```
### Tag: package-2022-02-preview-only
These settings apply only when `--tag=package-2022-02-preview-only` is specified on the command line.
-```yaml $(tag) == 'package-2022-02-preview-only'
+``` yaml $(tag) == 'package-2022-02-preview-only'
input-file:
- Microsoft.ContainerRegistry/preview/2022-02-01-preview/containerregistry.json
```
@@ -42,7 +80,7 @@ input-file:
These settings apply only when `--tag=package-2022-02-preview` is specified on the command line.
-```yaml $(tag) == 'package-2022-02-preview'
+``` yaml $(tag) == 'package-2022-02-preview'
input-file:
- Microsoft.ContainerRegistry/preview/2022-02-01-preview/containerregistry.json
- Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json
@@ -52,7 +90,7 @@ input-file:
These settings apply only when `--tag=package-2021-12-preview-only` is specified on the command line.
-```yaml $(tag) == 'package-2021-12-preview-only'
+``` yaml $(tag) == 'package-2021-12-preview-only'
input-file:
- Microsoft.ContainerRegistry/preview/2021-12-01-preview/containerregistry.json
```
diff --git a/specification/containerregistry/resource-manager/readme.nodejs.md b/specification/containerregistry/resource-manager/readme.nodejs.md
index daa46d96daf7..af21cc63acca 100644
--- a/specification/containerregistry/resource-manager/readme.nodejs.md
+++ b/specification/containerregistry/resource-manager/readme.nodejs.md
@@ -12,6 +12,6 @@ nodejs:
generate-package-json: true
generate-readme-md: true
input-file:
-- Microsoft.ContainerRegistry/preview/2022-02-01-preview/containerregistry.json
+- Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
- Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json
```
diff --git a/specification/containerregistry/resource-manager/readme.python.md b/specification/containerregistry/resource-manager/readme.python.md
index 8d5d8f9a7606..f6e40dc6521e 100644
--- a/specification/containerregistry/resource-manager/readme.python.md
+++ b/specification/containerregistry/resource-manager/readme.python.md
@@ -20,6 +20,8 @@ Generate all API versions currently shipped for this package
multiapi: true
clear-output-folder: true
batch:
+ - tag: package-2023-01-preview-only
+ - tag: package-2022-12-only
- tag: package-2022-02-preview-only
- tag: package-2021-12-preview-only
- tag: package-2021-09-only
@@ -43,6 +45,26 @@ output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregis
perform-load: false
```
+### Tag: package-2023-01-preview-only and python
+
+These settings apply only when `--tag=package-2023-01-preview-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2023-01-preview-only' && $(python)
+namespace: azure.mgmt.containerregistry.v2023_01_01_preview
+output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2023_01_01_preview
+```
+
+### Tag: package-2022-12-only and python
+
+These settings apply only when `--tag=package-2022-12-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-12-only' && $(python)
+namespace: azure.mgmt.containerregistry.v2022_12_01
+output-folder: $(python-sdks-folder)/containerregistry/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2022_12_01
+```
+
### Tag: package-2022-02-preview-only and python
These settings apply only when `--tag=package-2022-02-preview-only --python` is specified on the command line.
diff --git a/specification/containerregistry/resource-manager/readme.ruby.md b/specification/containerregistry/resource-manager/readme.ruby.md
index d2c0486ec9bc..564694a1dfed 100644
--- a/specification/containerregistry/resource-manager/readme.ruby.md
+++ b/specification/containerregistry/resource-manager/readme.ruby.md
@@ -12,6 +12,8 @@ azure-arm: true
``` yaml $(ruby) && $(multiapi)
batch:
+ - tag: package-2023-01-preview
+ - tag: package-2022-12
- tag: package-2022-02-preview
- tag: package-2021-12-preview
- tag: package-2021-09
@@ -25,6 +27,26 @@ batch:
- tag: package-2016-06-preview
```
+### Tag: package-2023-01-preview and ruby
+
+These settings apply only when `--tag=package-2023-01-preview --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2023-01-preview' && $(ruby)
+namespace: "Azure::ContainerRegistry::Mgmt::V2023_01_01_preview"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib
+```
+
+### Tag: package-2022-12 and ruby
+
+These settings apply only when `--tag=package-2022-12 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-12' && $(ruby)
+namespace: "Azure::ContainerRegistry::Mgmt::V2022_12_01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib
+```
+
### Tag: package-2022-02-preview and ruby
These settings apply only when `--tag=package-2022-02-preview --ruby` is specified on the command line.
diff --git a/specification/containerregistry/resource-manager/readme.typescript.md b/specification/containerregistry/resource-manager/readme.typescript.md
index 02669cd554ea..e19b58af8bbe 100644
--- a/specification/containerregistry/resource-manager/readme.typescript.md
+++ b/specification/containerregistry/resource-manager/readme.typescript.md
@@ -13,7 +13,7 @@ modelerfour:
``` yaml $(typescript)
input-file:
- - Microsoft.ContainerRegistry/preview/2022-02-01-preview/containerregistry.json
+ - Microsoft.ContainerRegistry/preview/2023-01-01-preview/containerregistry.json
- Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json
typescript:
azure-arm: true
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2021-11-01-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2021-11-01-preview/managedClusters.json
index d03d9df06731..75271f6553a2 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2021-11-01-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2021-11-01-preview/managedClusters.json
@@ -3785,7 +3785,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-01-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-01-02-preview/managedClusters.json
index a61441354f5b..71f68fab6e78 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-01-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-01-02-preview/managedClusters.json
@@ -3829,7 +3829,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json
index d027a82e5627..f0ace02bbc5b 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json
@@ -4033,7 +4033,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json
index c27aacd76a4d..f1933fe92065 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-03-02-preview/managedClusters.json
@@ -4000,7 +4000,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-04-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-04-02-preview/managedClusters.json
index 389fb248f061..7bc5e525e2ba 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-04-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-04-02-preview/managedClusters.json
@@ -4245,7 +4245,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-05-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-05-02-preview/managedClusters.json
index 5f8a7cad9514..a3bca000d9e8 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-05-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-05-02-preview/managedClusters.json
@@ -4246,7 +4246,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json
index b59adc494473..6e5f22654d98 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-06-02-preview/managedClusters.json
@@ -4251,7 +4251,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json
index f72a1686c0f0..7a1c36d965b5 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-07-02-preview/managedClusters.json
@@ -4397,7 +4397,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json
index b555bfc5501d..e0fe0dbd0c05 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-02-preview/managedClusters.json
@@ -4493,7 +4493,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json
index 317801d097f9..e179563b2d63 100644
--- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-08-03-preview/managedClusters.json
@@ -4529,7 +4529,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
- "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ "description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAbortOperation.json
new file mode 100644
index 000000000000..1c3ca5f56d93
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAbortOperation.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1"
+ },
+ "responses": {
+ "204": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAssociate_CRG.json
new file mode 100644
index 000000000000..b206bb6004ed
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsAssociate_CRG.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "capacityReservationGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "capacityReservationGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "capacityReservationGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json
new file mode 100644
index 000000000000..cd8f854e4643
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json
@@ -0,0 +1,124 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false,
+ "podMaxPids": 100
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 65536,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json
new file mode 100644
index 000000000000..af99582ba085
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json
new file mode 100644
index 000000000000..c459ae98ccf5
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableCustomCATrust.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "enableCustomCATrust": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableCustomCATrust": true
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableCustomCATrust": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json
new file mode 100644
index 000000000000..f7c3df1fc880
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "enableEncryptionAtHost": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.13",
+ "currentOrchestratorVersion": "1.17.13",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableEncryptionAtHost": true
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.13",
+ "currentOrchestratorVersion": "1.17.13",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableEncryptionAtHost": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json
new file mode 100644
index 000000000000..361e7cc6bf92
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableFIPS.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "enableFIPS": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableFIPS": true
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableFIPS": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json
new file mode 100644
index 000000000000..5b8cd0a0232a
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "enableUltraSSD": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.13",
+ "currentOrchestratorVersion": "1.17.13",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableUltraSSD": true
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.13",
+ "currentOrchestratorVersion": "1.17.13",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableUltraSSD": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json
new file mode 100644
index 000000000000..652d8c631fb7
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Ephemeral.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "osDiskType": "Ephemeral",
+ "osDiskSizeGB": 64
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskType": "Ephemeral",
+ "osDiskSizeGB": 64
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskType": "Ephemeral",
+ "kubeletDiskType": "OS",
+ "osDiskSizeGB": 64
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json
new file mode 100644
index 000000000000..76eca4fb8134
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_GPUMIG.json
@@ -0,0 +1,127 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG2g",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "maxPods": 110,
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG2g",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "maxPods": 110,
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG2g",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false,
+ "podMaxPids": 100
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 65536,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json
new file mode 100644
index 000000000000..698a44947c6a
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "messageOfTheDay": "Zm9vCg=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "messageOfTheDay": "Zm9vCg=="
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "messageOfTheDay": "Zm9vCg=="
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_OSSKU.json
new file mode 100644
index 000000000000..cfe725e1c8ca
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_OSSKU.json
@@ -0,0 +1,127 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 12345,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "kubeletConfig": {
+ "cpuManagerPolicy": "static",
+ "cpuCfsQuota": true,
+ "cpuCfsQuotaPeriod": "200ms",
+ "imageGcHighThreshold": 90,
+ "imageGcLowThreshold": 70,
+ "topologyManagerPolicy": "best-effort",
+ "allowedUnsafeSysctls": [
+ "kernel.msg*",
+ "net.core.somaxconn"
+ ],
+ "failSwapOn": false,
+ "podMaxPids": 100
+ },
+ "linuxOSConfig": {
+ "sysctls": {
+ "netCoreWmemDefault": 65536,
+ "netIpv4TcpTwReuse": true,
+ "netIpv4IpLocalPortRange": "20000 60000",
+ "kernelThreadsMax": 99999
+ },
+ "transparentHugePageEnabled": "always",
+ "transparentHugePageDefrag": "madvise",
+ "swapFileSizeMB": 1500
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_PPG.json
new file mode 100644
index 000000000000..ad9a92b360a3
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_PPG.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Snapshot.json
new file mode 100644
index 000000000000..b9d45096a63a
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Snapshot.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.19.6",
+ "currentOrchestratorVersion": "1.19.6",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Spot.json
new file mode 100644
index 000000000000..366ebf154d41
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Spot.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete",
+ "spotMaxPrice": -1
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete",
+ "spotMaxPrice": -1
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Update.json
new file mode 100644
index 000000000000..3434895cc466
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_Update.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete",
+ "mode": "User"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete",
+ "mode": "User",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "tags": {
+ "name1": "val1"
+ },
+ "nodeLabels": {
+ "key1": "val1"
+ },
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete",
+ "mode": "User"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json
new file mode 100644
index 000000000000..a59ecb1cf661
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WasmWasi.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "workloadRuntime": "WasmWasi"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "workloadRuntime": "WasmWasi"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.17.8",
+ "currentOrchestratorVersion": "1.17.8",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osDiskSizeGB": 64,
+ "mode": "User",
+ "workloadRuntime": "WasmWasi"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json
new file mode 100644
index 000000000000..5577bac97cfc
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "wnp2",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "1.23.8",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "osType": "Windows",
+ "osSKU": "Windows2022",
+ "windowsProfile": {
+ "disableOutboundNat": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "wnp2",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.23.8",
+ "currentOrchestratorVersion": "1.23.8",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "maxPods": 110,
+ "osType": "Windows",
+ "osSKU": "Windows2022",
+ "windowsProfile": {
+ "disableOutboundNat": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "wnp2",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.23.8",
+ "currentOrchestratorVersion": "1.23.8",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "maxPods": 110,
+ "osType": "Windows",
+ "osSKU": "Windows2022",
+ "windowsProfile": {
+ "disableOutboundNat": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json
new file mode 100644
index 000000000000..93096892381f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "wnp2",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "1.23.3",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "osType": "Windows",
+ "osSKU": "Windows2022"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "wnp2",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.23.3",
+ "currentOrchestratorVersion": "1.23.3",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "maxPods": 110,
+ "osType": "Windows",
+ "osSKU": "Windows2022"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "wnp2",
+ "properties": {
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.23.3",
+ "currentOrchestratorVersion": "1.23.3",
+ "count": 3,
+ "vmSize": "Standard_D4s_v3",
+ "maxPods": 110,
+ "osType": "Windows",
+ "osSKU": "Windows2022"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete.json
new file mode 100644
index 000000000000..b586ba1e2d05
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json
new file mode 100644
index 000000000000..3a074d479b6c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "ignorePodDisruptionBudget": true
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGet.json
new file mode 100644
index 000000000000..3b277a6b3c8d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "upgradeSettings": {
+ "maxSurge": "33%"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json
new file mode 100644
index 000000000000..53b054789f9f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions",
+ "name": "default",
+ "properties": {
+ "agentPoolVersions": [
+ {
+ "kubernetesVersion": "1.12.7"
+ },
+ {
+ "kubernetesVersion": "1.12.8"
+ },
+ {
+ "default": true,
+ "kubernetesVersion": "1.13.5",
+ "isPreview": true
+ }
+ ]
+ },
+ "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json
new file mode 100644
index 000000000000..2c05388d7184
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsGetUpgradeProfile.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default",
+ "name": "default",
+ "properties": {
+ "kubernetesVersion": "1.12.8",
+ "osType": "Linux",
+ "upgrades": [
+ {
+ "kubernetesVersion": "1.13.5"
+ }
+ ],
+ "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ },
+ "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsList.json
new file mode 100644
index 000000000000..646d02cc0c86
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsList.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json
new file mode 100644
index 000000000000..02e64e342369
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31"
+ },
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "UpgradingNodeImageVersion",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "nodeImageVersion": "AKSUbuntu-1604-2020.03.11",
+ "upgradeSettings": {
+ "maxSurge": "33%"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Start.json
new file mode 100644
index 000000000000..9a56a8608e06
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Start.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "powerState": {
+ "code": "Running"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Starting",
+ "count": 50,
+ "enableAutoScaling": true,
+ "minCount": 3,
+ "maxCount": 55,
+ "powerState": {
+ "code": "Running"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Starting",
+ "count": 50,
+ "enableAutoScaling": true,
+ "minCount": 3,
+ "maxCount": 55,
+ "powerState": {
+ "code": "Running"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Stop.json
new file mode 100644
index 000000000000..7f7bc164810b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Stop.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "powerState": {
+ "code": "Stopped"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Stopping",
+ "count": 0,
+ "enableAutoScaling": false,
+ "minCount": null,
+ "maxCount": null,
+ "powerState": {
+ "code": "Stopped"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Stopping",
+ "count": 0,
+ "enableAutoScaling": false,
+ "minCount": null,
+ "maxCount": null,
+ "powerState": {
+ "code": "Stopped"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Update.json
new file mode 100644
index 000000000000..914d1d43be9d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/AgentPools_Update.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "agentPoolName": "agentpool1",
+ "parameters": {
+ "properties": {
+ "orchestratorVersion": "",
+ "count": 3,
+ "enableAutoScaling": true,
+ "minCount": 2,
+ "maxCount": 2,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "enableAutoScaling": true,
+ "minCount": 2,
+ "maxCount": 2,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1",
+ "type": "Microsoft.ContainerService/managedClusters/agentPools",
+ "name": "agentpool1",
+ "properties": {
+ "provisioningState": "Updating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "count": 3,
+ "enableAutoScaling": true,
+ "minCount": 2,
+ "maxCount": 2,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "nodeTaints": [
+ "Key1=Value1:NoSchedule"
+ ],
+ "scaleSetPriority": "Spot",
+ "scaleSetEvictionPolicy": "Delete"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ContainerServiceGetOSOptions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ContainerServiceGetOSOptions.json
new file mode 100644
index 000000000000..ec18cf687035
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ContainerServiceGetOSOptions.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "location": "location1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/locations/location1/osOptions/default",
+ "name": "default",
+ "type": "Microsoft.ContainerService/locations/osOptions",
+ "properties": {
+ "osOptionPropertyList": [
+ {
+ "os-type": "Linux",
+ "enable-fips-image": false
+ },
+ {
+ "os-type": "Windows",
+ "enable-fips-image": false
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json
new file mode 100644
index 000000000000..7898e877a776
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "default",
+ "parameters": {
+ "properties": {
+ "timeInWeek": [
+ {
+ "day": "Monday",
+ "hourSlots": [
+ 1,
+ 2
+ ]
+ }
+ ],
+ "notAllowedTime": [
+ {
+ "start": "2020-11-26T03:00:00Z",
+ "end": "2020-11-30T12:00:00Z"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "name": "default",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "timeInWeek": [
+ {
+ "day": "Monday",
+ "hourSlots": [
+ 1,
+ 2
+ ]
+ }
+ ],
+ "notAllowedTime": [
+ {
+ "start": "2020-11-26T03:00:00Z",
+ "end": "2020-11-30T12:00:00Z"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json
new file mode 100644
index 000000000000..75bd802eeb23
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "aksManagedAutoUpgradeSchedule",
+ "parameters": {
+ "properties": {
+ "maintenanceWindow": {
+ "schedule": {
+ "relativeMonthly": {
+ "intervalMonths": 3,
+ "weekIndex": "First",
+ "dayOfWeek": "Monday"
+ }
+ },
+ "durationHours": 10,
+ "utcOffset": "+05:30",
+ "startDate": "2023-01-01",
+ "startTime": "08:30",
+ "notAllowedDates": [
+ {
+ "start": "2023-02-18",
+ "end": "2023-02-25"
+ },
+ {
+ "start": "2023-12-23",
+ "end": "2024-01-05"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations",
+ "name": "aksManagedAutoUpgradeSchedule",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "maintenanceWindow": {
+ "schedule": {
+ "weekly": {
+ "intervalWeeks": 3,
+ "dayOfWeek": "Monday"
+ }
+ },
+ "durationHours": 10,
+ "utcOffset": "+05:30",
+ "startDate": "2023-01-01",
+ "startTime": "08:30",
+ "notAllowedDates": [
+ {
+ "start": "2023-02-18",
+ "end": "2023-02-25"
+ },
+ {
+ "start": "2023-12-23",
+ "end": "2024-01-05"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete.json
new file mode 100644
index 000000000000..9cd6a86e141a
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "default"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json
new file mode 100644
index 000000000000..372ffe1da4b5
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "aksManagedNodeOSUpgradeSchedule"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet.json
new file mode 100644
index 000000000000..7269d8d7a0f9
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "default"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "name": "default",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "timeInWeek": [
+ {
+ "day": "Monday",
+ "hourSlots": [
+ 1,
+ 2
+ ]
+ }
+ ],
+ "notAllowedTime": [
+ {
+ "start": "2020-11-26T03:00:00Z",
+ "end": "2020-11-30T12:00:00Z"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json
new file mode 100644
index 000000000000..550ddd32ccf4
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "configName": "aksManagedNodeOSUpgradeSchedule"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "name": "aksManagedNodeOSUpgradeSchedule",
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2020-01-01T17:18:19.1234567Z",
+ "lastModifiedBy": "user2",
+ "lastModifiedByType": "User",
+ "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
+ },
+ "properties": {
+ "maintenanceWindow": {
+ "schedule": {
+ "daily": {
+ "intervalDays": 3
+ }
+ },
+ "durationHours": 4,
+ "utcOffset": "-07:00",
+ "startDate": "2023-01-01",
+ "startTime": "09:30",
+ "notAllowedDates": [
+ {
+ "start": "2023-02-18",
+ "end": "2023-02-25"
+ },
+ {
+ "start": "2023-12-23",
+ "end": "2024-01-05"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList.json
new file mode 100644
index 000000000000..b9a158bdffa2
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "name": "default",
+ "properties": {
+ "timeInWeek": [
+ {
+ "day": "Monday",
+ "hourSlots": [
+ 1,
+ 2
+ ]
+ }
+ ],
+ "notAllowedTime": [
+ {
+ "start": "2020-11-26T03:00:00Z",
+ "end": "2020-11-30T12:00:00Z"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json
new file mode 100644
index 000000000000..d72d9d133887
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "name": "aksManagedNodeOSUpgradeSchedule",
+ "properties": {
+ "maintenanceWindow": {
+ "schedule": {
+ "daily": {
+ "intervalDays": 5
+ }
+ },
+ "durationHours": 10,
+ "utcOffset": "-07:00",
+ "startDate": "2023-01-01",
+ "startTime": "13:30"
+ }
+ }
+ },
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default",
+ "name": "aksManagedAutoUpgradeSchedule",
+ "properties": {
+ "maintenanceWindow": {
+ "schedule": {
+ "absoluteMonthly": {
+ "intervalMonths": 3,
+ "dayOfMonth": 15
+ }
+ },
+ "durationHours": 5,
+ "utcOffset": "+00:00",
+ "startDate": "2023-01-01",
+ "startTime": "08:30",
+ "notAllowedDates": [
+ {
+ "start": "2023-02-18",
+ "end": "2023-02-25"
+ },
+ {
+ "start": "2023-12-23",
+ "end": "2024-01-05"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsCreate.json
new file mode 100644
index 000000000000..50916cc1a59e
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsCreate.json
@@ -0,0 +1,96 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsDelete.json
new file mode 100644
index 000000000000..18a77874eaf8
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsGet.json
new file mode 100644
index 000000000000..38ab0c0d4bd1
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsGet.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsList.json
new file mode 100644
index 000000000000..f2c06114776b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsList.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json
new file mode 100644
index 000000000000..ecaa241539dd
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json
new file mode 100644
index 000000000000..4e504ebb89b1
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1",
+ "parameters": {
+ "tags": {
+ "key2": "new-val2",
+ "key3": "val3"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1",
+ "type": "Microsoft.ContainerService/ManagedClusterSnapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1"
+ },
+ "snapshotType": "ManagedCluster",
+ "managedClusterPropertiesReadOnly": {
+ "kubernetesVersion": "1.20.5",
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "enableRbac": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "networkPolicy": "calico",
+ "networkMode": "bridge",
+ "loadBalancerSku": "standard"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAbortOperation.json
new file mode 100644
index 000000000000..1a6fd29af737
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAbortOperation.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "204": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAssociate_CRG.json
new file mode 100644
index 000000000000..56dbe21cdb01
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersAssociate_CRG.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "capacityReservationGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "capacityReservationGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json
new file mode 100644
index 000000000000..4251afccfe1d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json
@@ -0,0 +1,261 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {
+ "azureKeyvaultSecretsProvider": {
+ "enabled": true,
+ "config": {
+ "enableSecretRotation": "true",
+ "rotationPollInterval": "2m"
+ }
+ }
+ },
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "addonProfiles": {
+ "azureKeyvaultSecretsProvider": {
+ "enabled": true,
+ "config": {
+ "enableSecretRotation": "true",
+ "rotationPollInterval": "2m"
+ }
+ }
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "addonProfiles": {
+ "azureKeyvaultSecretsProvider": {
+ "enabled": true,
+ "config": {
+ "enableSecretRotation": "true",
+ "rotationPollInterval": "2m"
+ }
+ }
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json
new file mode 100644
index 000000000000..ea67fcc9625d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json
@@ -0,0 +1,253 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "hostGroupID": "/subscriptions/subid1/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json
new file mode 100644
index 000000000000..cf38a155bc05
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json
@@ -0,0 +1,265 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "apiServerAccessProfile": {
+ "disableRunCommand": true
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "disableRunCommand": true
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io",
+ "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "disableRunCommand": true
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io",
+ "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json
new file mode 100644
index 000000000000..4ec2cc8c194b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json
@@ -0,0 +1,323 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ },
+ "ipFamilies": [
+ "IPv4",
+ "IPv6"
+ ]
+ },
+ "autoScalerProfile": {
+ "balance-similar-node-groups": "true",
+ "expander": "priority",
+ "max-node-provision-time": "15m",
+ "new-pod-scale-up-delay": "1m",
+ "scale-down-delay-after-add": "15m",
+ "scan-interval": "20s",
+ "skip-nodes-with-system-pods": "false"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16",
+ "fd11:1234::/64"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16",
+ "fd00:1234::/108"
+ ],
+ "ipFamilies": [
+ "IPv4",
+ "IPv6"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2,
+ "countIPv6": 1
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "balance-similar-node-groups": "true",
+ "expander": "priority",
+ "max-node-provision-time": "15m",
+ "new-pod-scale-up-delay": "1m",
+ "scale-down-delay-after-add": "15m",
+ "scan-interval": "20s",
+ "skip-nodes-with-system-pods": "false"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16",
+ "fd11:1234::/64"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16",
+ "fd00:1234::/108"
+ ],
+ "ipFamilies": [
+ "IPv4",
+ "IPv6"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2,
+ "countIPv6": 1
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json
new file mode 100644
index 000000000000..1fa950934e04
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableCustomCATrust.json
@@ -0,0 +1,271 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableCustomCATrust": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "securityProfile": {
+ "customCATrustCertificates": [
+ "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ="
+ ]
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableCustomCATrust": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "securityProfile": {
+ "customCATrustCertificates": [
+ "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ="
+ ]
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableCustomCATrust": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "securityProfile": {
+ "customCATrustCertificates": [
+ "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ="
+ ]
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json
new file mode 100644
index 000000000000..b7b682e2610d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json
new file mode 100644
index 000000000000..17df1b961f62
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableUltraSSD": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableUltraSSD": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableUltraSSD": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json
new file mode 100644
index 000000000000..d68f16582f26
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json
new file mode 100644
index 000000000000..bd9e8c3d64a5
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_GPUMIG.json
@@ -0,0 +1,283 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG3g",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "maxPods": 110,
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG3g",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_ND96asr_v4",
+ "maxPods": 110,
+ "osType": "Linux",
+ "gpuInstanceProfile": "MIG3g",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json
new file mode 100644
index 000000000000..f7e7f23be182
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_HTTPProxy.json
@@ -0,0 +1,280 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json
new file mode 100644
index 000000000000..a8cb737d81fa
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json
@@ -0,0 +1,245 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "ingressProfile": {
+ "webAppRouting": {
+ "enabled": true,
+ "dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "ingressProfile": {
+ "webAppRouting": {
+ "enabled": true,
+ "dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "ingressProfile": {
+ "webAppRouting": {
+ "enabled": true,
+ "dnsZoneResourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json
new file mode 100644
index 000000000000..301437c5d768
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_MCSnapshot.json
@@ -0,0 +1,224 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1"
+ },
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1"
+ },
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1"
+ },
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json
new file mode 100644
index 000000000000..e10091670571
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json
@@ -0,0 +1,233 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "managedNATGateway",
+ "natGatewayProfile": {
+ "managedOutboundIPProfile": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "managedNATGateway",
+ "natGatewayProfile": {
+ "idleTimeoutInMinutes": 4,
+ "managedOutboundIPProfile": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "managedNATGateway",
+ "natGatewayProfile": {
+ "idleTimeoutInMinutes": 4,
+ "managedOutboundIPProfile": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json
new file mode 100644
index 000000000000..b53001565b17
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodePublicIPPrefixID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_OSSKU.json
new file mode 100644
index 000000000000..15ee2c55212f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_OSSKU.json
@@ -0,0 +1,283 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "osSKU": "CBLMariner",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "httpProxyConfig": {
+ "httpProxy": "http://myproxy.server.com:8080",
+ "httpsProxy": "https://myproxy.server.com:8080",
+ "noProxy": [
+ "localhost",
+ "127.0.0.1"
+ ],
+ "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U="
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PPG.json
new file mode 100644
index 000000000000..925b43f0388b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PPG.json
@@ -0,0 +1,256 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json
new file mode 100644
index 000000000000..294d540421a4
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PodIdentity.json
@@ -0,0 +1,265 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "podIdentityProfile": {
+ "enabled": true,
+ "allowNetworkPluginKubenet": true
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "podIdentityProfile": {
+ "enabled": true,
+ "allowNetworkPluginKubenet": true
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "podIdentityProfile": {
+ "enabled": true,
+ "allowNetworkPluginKubenet": true
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json
new file mode 100644
index 000000000000..2ac008ef2b5b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json
@@ -0,0 +1,266 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "fqdnSubdomain": "domain1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "fqdnSubdomain": "domain1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true,
+ "privateFQDN": "domain1.privatelink.location1.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "fqdnSubdomain": "domain1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "privateDNSZone": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "privateFQDN": "domain1.privatelink.location1.azmk8s.io",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json
new file mode 100644
index 000000000000..7614a386692f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json
@@ -0,0 +1,270 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "enablePrivateClusterPublicFQDN": true
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "enablePrivateClusterPublicFQDN": true,
+ "privateDNSZone": "system"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io",
+ "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableEncryptionAtHost": true
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "apiServerAccessProfile": {
+ "enablePrivateCluster": true,
+ "enablePrivateClusterPublicFQDN": true,
+ "privateDNSZone": "system"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io",
+ "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json
new file mode 100644
index 000000000000..9840f282f613
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_SecurityProfile.json
@@ -0,0 +1,253 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "securityProfile": {
+ "defender": {
+ "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME",
+ "securityMonitoring": {
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "securityProfile": {
+ "defender": {
+ "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME",
+ "securityMonitoring": {
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "securityProfile": {
+ "defender": {
+ "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME",
+ "securityMonitoring": {
+ "enabled": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Snapshot.json
new file mode 100644
index 000000000000..12387dba1479
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Snapshot.json
@@ -0,0 +1,265 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "enableFIPS": true,
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1"
+ }
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": false,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Update.json
new file mode 100644
index 000000000000..ab426edb2b8f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_Update.json
@@ -0,0 +1,305 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "balance-similar-node-groups": "true",
+ "expander": "priority",
+ "max-node-provision-time": "15m",
+ "new-pod-scale-up-delay": "1m",
+ "scale-down-delay-after-add": "15m",
+ "scan-interval": "20s",
+ "skip-nodes-with-system-pods": "false"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "balance-similar-node-groups": "true",
+ "expander": "priority",
+ "max-node-provision-time": "15m",
+ "new-pod-scale-up-delay": "1m",
+ "scale-down-delay-after-add": "15m",
+ "scan-interval": "20s",
+ "skip-nodes-with-system-pods": "false"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "scaleDownMode": "Deallocate",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json
new file mode 100644
index 000000000000..fb22cf036175
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json
@@ -0,0 +1,301 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$",
+ "gmsaProfile": {
+ "enabled": true
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "gmsaProfile": {
+ "enabled": true
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "gmsaProfile": {
+ "enabled": true
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json
new file mode 100644
index 000000000000..e972c857f595
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json
@@ -0,0 +1,295 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$",
+ "licenseType": "Windows_Server"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "licenseType": "Windows_Server"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "licenseType": "Windows_Server"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {
+ "principalId": "principalId1",
+ "clientId": "clientId1"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json
new file mode 100644
index 000000000000..d60ed4c2bbb2
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json
@@ -0,0 +1,284 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "aadProfile": {
+ "managed": true,
+ "enableAzureRBAC": true
+ },
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "aadProfile": {
+ "managed": true,
+ "adminGroupObjectIDs": null,
+ "enableAzureRBAC": true,
+ "tenantID": "tenantID"
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "aadProfile": {
+ "managed": true,
+ "adminGroupObjectIDs": null,
+ "enableAzureRBAC": true,
+ "tenantID": "tenantID"
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json
new file mode 100644
index 000000000000..979da855bae5
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json
@@ -0,0 +1,271 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "loadBalancerProfile": {
+ "managedOutboundIPs": {
+ "count": 2
+ }
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "enableNamespaceResources": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "enableNamespaceResources": true
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "enableNodePublicIP": true,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "managedOutboundIPs": {
+ "count": 2
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "enableNamespaceResources": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json
new file mode 100644
index 000000000000..7ed5c259629d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json
@@ -0,0 +1,200 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "location": "location1",
+ "tags": {
+ "tier": "production",
+ "archv2": ""
+ },
+ "sku": {
+ "name": "Basic",
+ "tier": "Free"
+ },
+ "properties": {
+ "kubernetesVersion": "",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "osType": "Linux",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "networkProfile": {
+ "loadBalancerSku": "standard",
+ "outboundType": "userAssignedNATGateway"
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser",
+ "adminPassword": "replacePassword1234$"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid",
+ "secret": "secret"
+ },
+ "addonProfiles": {},
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System",
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "loadBalancerSku": "basic",
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "outboundType": "userAssignedNATGateway"
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Creating",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS2_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Creating",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "type": "VirtualMachineScaleSets",
+ "enableNodePublicIP": false,
+ "mode": "System"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "windowsProfile": {
+ "adminUsername": "azureuser"
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": true,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "enablePodSecurityPolicy": true,
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "userAssignedNATGateway"
+ },
+ "autoScalerProfile": {
+ "scan-interval": "20s",
+ "scale-down-delay-after-add": "15m"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersDelete.json
new file mode 100644
index 000000000000..92963b95aa5c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersDelete.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGet.json
new file mode 100644
index 000000000000..171df4451c83
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGet.json
@@ -0,0 +1,107 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "maxAgentPools": 1,
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6",
+ "availabilityZones": [
+ "1",
+ "2",
+ "3"
+ ],
+ "nodeImageVersion": "AKSUbuntu:1604:2020.03.11",
+ "upgradeSettings": {
+ "maxSurge": "33%"
+ }
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": false,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16",
+ "loadBalancerSku": "standard",
+ "outboundType": "loadBalancer",
+ "podCidrs": [
+ "10.244.0.0/16"
+ ],
+ "serviceCidrs": [
+ "10.0.0.0/16"
+ ],
+ "ipFamilies": [
+ "IPv4"
+ ],
+ "loadBalancerProfile": {
+ "allocatedOutboundPorts": 2000,
+ "idleTimeoutInMinutes": 10,
+ "outboundIPs": {
+ "publicIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2"
+ }
+ ]
+ },
+ "effectiveOutboundIPs": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1"
+ },
+ {
+ "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetAccessProfile.json
new file mode 100644
index 000000000000..ab0062366b4d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetAccessProfile.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "roleName": "clusterUser"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser",
+ "location": "location1",
+ "name": "clusterUser",
+ "properties": {
+ "kubeConfig": "a3ViZUNvbmZpZzE="
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json
new file mode 100644
index 000000000000..fa65fbc2db62
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersGetUpgradeProfile.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default",
+ "name": "default",
+ "properties": {
+ "agentPoolProfiles": [
+ {
+ "kubernetesVersion": "1.7.7",
+ "name": "agent",
+ "osType": "Linux",
+ "upgrades": [
+ {
+ "kubernetesVersion": "1.7.9"
+ },
+ {
+ "kubernetesVersion": "1.7.11",
+ "isPreview": true
+ }
+ ]
+ }
+ ],
+ "controlPlaneProfile": {
+ "kubernetesVersion": "1.7.7",
+ "name": "master",
+ "osType": "Linux",
+ "upgrades": [
+ {
+ "kubernetesVersion": "1.7.9",
+ "isPreview": true
+ },
+ {
+ "kubernetesVersion": "1.7.11"
+ }
+ ]
+ }
+ },
+ "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersList.json
new file mode 100644
index 000000000000..5be70bdc1182
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersList.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "kubernetesVersion": "1.9.6",
+ "maxAgentPools": 1,
+ "dnsPrefix": "dnsprefix1",
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": false,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListByResourceGroup.json
new file mode 100644
index 000000000000..26cf59c08a62
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListByResourceGroup.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv2": "",
+ "tier": "production"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "kubernetesVersion": "1.9.6",
+ "maxAgentPools": 1,
+ "dnsPrefix": "dnsprefix1",
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": false,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json
new file mode 100644
index 000000000000..1ab108df008d
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersListClusterCredentialResult.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "kubeconfigs": [
+ {
+ "name": "credentialName1",
+ "value": "Y3JlZGVudGlhbFZhbHVlMQ=="
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetAADProfile.json
new file mode 100644
index 000000000000..5a3f7bd9d213
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetAADProfile.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "clientAppID": "clientappid",
+ "serverAppID": "serverappid",
+ "serverAppSecret": "serverappsecret",
+ "tenantID": "tenantid"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json
new file mode 100644
index 000000000000..0fef4bc57d7b
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "clientId": "clientid",
+ "secret": "secret"
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json
new file mode 100644
index 000000000000..92963b95aa5c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateClusterCertificates.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json
new file mode 100644
index 000000000000..92963b95aa5c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStart.json
new file mode 100644
index 000000000000..92963b95aa5c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStart.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStop.json
new file mode 100644
index 000000000000..92963b95aa5c
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersStop.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersUpdateTags.json
new file mode 100644
index 000000000000..8fd1e7622288
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ManagedClustersUpdateTags.json
@@ -0,0 +1,69 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "tags": {
+ "tier": "testing",
+ "archv3": ""
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1",
+ "location": "location1",
+ "name": "clustername1",
+ "tags": {
+ "archv3": "",
+ "tier": "testing"
+ },
+ "type": "Microsoft.ContainerService/ManagedClusters",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "kubernetesVersion": "1.9.6",
+ "dnsPrefix": "dnsprefix1",
+ "agentPoolProfiles": [
+ {
+ "name": "nodepool1",
+ "count": 3,
+ "vmSize": "Standard_DS1_v2",
+ "maxPods": 110,
+ "osType": "Linux",
+ "provisioningState": "Succeeded",
+ "orchestratorVersion": "1.9.6",
+ "currentOrchestratorVersion": "1.9.6"
+ }
+ ],
+ "linuxProfile": {
+ "adminUsername": "azureuser",
+ "ssh": {
+ "publicKeys": [
+ {
+ "keyData": "keydata"
+ }
+ ]
+ }
+ },
+ "servicePrincipalProfile": {
+ "clientId": "clientid"
+ },
+ "nodeResourceGroup": "MC_rg1_clustername1_location1",
+ "enableRBAC": false,
+ "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des",
+ "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io",
+ "networkProfile": {
+ "networkPlugin": "kubenet",
+ "podCidr": "10.244.0.0/16",
+ "serviceCidr": "10.0.0.0/16",
+ "dnsServiceIP": "10.0.0.10",
+ "dockerBridgeCidr": "172.17.0.1/16"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/Operation_List.json
new file mode 100644
index 000000000000..b904dbc19ea7
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/Operation_List.json
@@ -0,0 +1,3583 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "display": {
+ "description": "Gets the status of an asynchronous operation",
+ "operation": "Get Operation",
+ "provider": "Microsoft Container Service",
+ "resource": "Operation"
+ },
+ "name": "Microsoft.ContainerService/locations/operations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Lists the supported orchestrators",
+ "operation": "List Orchestrators",
+ "provider": "Microsoft Container Service",
+ "resource": "Orchestrator"
+ },
+ "name": "Microsoft.ContainerService/locations/orchestrators/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets OS options",
+ "operation": "Get OS Options",
+ "provider": "Microsoft Container Service",
+ "resource": "OSOptions"
+ },
+ "name": "Microsoft.ContainerService/locations/osOptions/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Lists operations available on Microsoft.ContainerService resource provider",
+ "operation": "List Available Container Service Operations",
+ "provider": "Microsoft Container Service",
+ "resource": "Available Container Service Operations"
+ },
+ "name": "Microsoft.ContainerService/operations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Registers Subscription with Microsoft.ContainerService resource provider",
+ "operation": "Register Subscription for Container Service",
+ "provider": "Microsoft Container Service",
+ "resource": "Container Service Register Subscription"
+ },
+ "name": "Microsoft.ContainerService/register/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Unregisters Subscription with Microsoft.ContainerService resource provider",
+ "operation": "Unregister Subscription for Container Service",
+ "provider": "Microsoft Container Service",
+ "resource": "Container Service Unregister Subscription"
+ },
+ "name": "Microsoft.ContainerService/unregister/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the status of an asynchronous operation result",
+ "operation": "Get Operation Result",
+ "provider": "Microsoft Container Service",
+ "resource": "OperationResult"
+ },
+ "name": "Microsoft.ContainerService/locations/operationresults/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get a container service",
+ "operation": "Get Container Service",
+ "provider": "Microsoft Container Service",
+ "resource": "Container Services"
+ },
+ "name": "Microsoft.ContainerService/containerServices/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new container service or updates an existing one",
+ "operation": "Create or Update Container Service",
+ "provider": "Microsoft Container Service",
+ "resource": "Container Services"
+ },
+ "name": "Microsoft.ContainerService/containerServices/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes a container service",
+ "operation": "Delete Container Service",
+ "provider": "Microsoft Container Service",
+ "resource": "Container Services"
+ },
+ "name": "Microsoft.ContainerService/containerServices/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get a managed cluster",
+ "operation": "Get Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new managed cluster or updates an existing one",
+ "operation": "Create or Update Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes a managed cluster",
+ "operation": "Delete Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Starts a managed cluster",
+ "operation": "Start Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/start/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Stops a managed cluster",
+ "operation": "Stop Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/stop/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets a maintenance configuration",
+ "operation": "Get a maintenance configuration",
+ "provider": "Microsoft Container Service",
+ "resource": "Maintenance Configurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new MaintenanceConfiguration or updates an existing one",
+ "operation": "Create or Update maintenance configuratio",
+ "provider": "Microsoft Container Service",
+ "resource": "Maintenance Configurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes a maintenance configuration",
+ "operation": "Delete Maintenance Configuration",
+ "provider": "Microsoft Container Service",
+ "resource": "Maintenance Configurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets an agent pool",
+ "operation": "Get Agent Pool",
+ "provider": "Microsoft Container Service",
+ "resource": "Agent Pools"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new agent pool or updates an existing one",
+ "operation": "Create or Update Agent Pool",
+ "provider": "Microsoft Container Service",
+ "resource": "Agent Pools"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes an agent pool",
+ "operation": "Delete Agent Pool",
+ "provider": "Microsoft Container Service",
+ "resource": "Agent Pools"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the upgrade profile of the Agent Pool",
+ "operation": "Get Agent Pool UpgradeProfile",
+ "provider": "Microsoft Container Service",
+ "resource": "Agent Pools"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Upgrade the node image version of agent pool",
+ "operation": "Upgrade agent pool node image version",
+ "provider": "Microsoft Container Service",
+ "resource": "Agent Pools"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the available agent pool versions of the cluster",
+ "operation": "Get Available Agent Pool Versions",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get a managed cluster access profile by role name",
+ "operation": "Get Managed Cluster AccessProfile",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get a managed cluster access profile by role name using list credential",
+ "operation": "Get Managed Cluster AccessProfile by List Credential",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the upgrade profile of the cluster",
+ "operation": "Get UpgradeProfile",
+ "provider": "Microsoft Container Service",
+ "resource": "UpgradeProfile"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "List the clusterAdmin credential of a managed cluster",
+ "operation": "List clusterAdmin credential",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "List the clusterUser credential of a managed cluster",
+ "operation": "List clusterUser credential",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "List the clusterMonitoringUser credential of a managed cluster",
+ "operation": "List clusterMonitoringUser credential",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reset the service principal profile of a managed cluster",
+ "operation": "Reset service principal profile",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Resolve the private link service id of a managed cluster",
+ "operation": "Resolve private link service id",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reset the AAD profile of a managed cluster",
+ "operation": "Reset AAD profile",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Rotate certificates of a managed cluster",
+ "operation": "Rotate certificates of the cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Run user issued command against managed kubernetes server.",
+ "operation": "RunCommand",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/runCommand/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Retrieve result from previous issued command.",
+ "operation": "CommandResult",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/commandResults/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get the diagnostic setting for a managed cluster resource",
+ "operation": "Read Diagnostic Setting",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Creates or updates the diagnostic setting for a managed cluster resource",
+ "operation": "Write Diagnostic Setting",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Clusters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Get Managed Cluster Detector",
+ "operation": "Get Managed Cluster Detector",
+ "provider": "Microsoft Container Service",
+ "resource": "Managed Cluster Detector"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/detectors/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the diagnostics state of the cluster",
+ "operation": "Get Diagnostics State",
+ "provider": "Microsoft Container Service",
+ "resource": "Diagnostics State"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Determines if user is allowed to approve a private endpoint connection",
+ "operation": "Approve Private Endpoint Connections",
+ "provider": "Microsoft Container Service",
+ "resource": "Approve Private Endpoint Connections"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get private endpoint connection",
+ "operation": "Get private endpoint connection",
+ "provider": "Microsoft Container Service",
+ "resource": "Private Endpoint Connections"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Approve or Reject a private endpoint connection",
+ "operation": "Update private endpoint connection",
+ "provider": "Microsoft Container Service",
+ "resource": "Private Endpoint Connections"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Delete private endpoint connection",
+ "operation": "Delete private endpoint connection",
+ "provider": "Microsoft Container Service",
+ "resource": "Private Endpoint Connections"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets an extension addon",
+ "operation": "Get an extension addon",
+ "provider": "Microsoft Container Service",
+ "resource": "ExtensionAddons"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Creates a new extension addon or updates an existing one",
+ "operation": "Create or Update extension addon",
+ "provider": "Microsoft Container Service",
+ "resource": "ExtensionAddons"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Deletes an extension addon",
+ "operation": "Delete an extension addon",
+ "provider": "Microsoft Container Service",
+ "resource": "ExtensionAddons"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Get a snapshot",
+ "operation": "Get Snapshot",
+ "provider": "Microsoft Container Service",
+ "resource": "Snapshots"
+ },
+ "name": "Microsoft.ContainerService/snapshots/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new snapshot",
+ "operation": "Create Snapshot",
+ "provider": "Microsoft Container Service",
+ "resource": "Snapshots"
+ },
+ "name": "Microsoft.ContainerService/snapshots/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes a snapshot",
+ "operation": "Delete Snapshot",
+ "provider": "Microsoft Container Service",
+ "resource": "Snapshots"
+ },
+ "name": "Microsoft.ContainerService/snapshots/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get eventgrid filter",
+ "operation": "Get eventgrid filter",
+ "provider": "Microsoft Container Service",
+ "resource": "EventGridFilters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Create or Update eventgrid filter",
+ "operation": "Create or Update eventgrid filter",
+ "provider": "Microsoft Container Service",
+ "resource": "EventGridFilters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Delete an eventgrid filter",
+ "operation": "Delete an eventgrid filter",
+ "provider": "Microsoft Container Service",
+ "resource": "EventGridFilters"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Reads initializerconfigurations",
+ "operation": "Gets/List initializerconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Initializerconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes initializerconfigurations",
+ "operation": "Creates/Updates initializerconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Initializerconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes/DeletesCollection initializerconfigurations resource",
+ "operation": "Initializerconfigurations",
+ "provider": "Microsoft Container Service",
+ "resource": "Initializerconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads mutatingwebhookconfigurations",
+ "operation": "Gets/List mutatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Mutatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes mutatingwebhookconfigurations",
+ "operation": "Creates/Updates mutatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Mutatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes mutatingwebhookconfigurations",
+ "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Mutatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads validatingwebhookconfigurations",
+ "operation": "Gets/List validatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Validatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes validatingwebhookconfigurations",
+ "operation": "Creates/Updates validatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Validatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes validatingwebhookconfigurations",
+ "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Validatingwebhookconfigurations"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads customresourcedefinitions",
+ "operation": "Gets/List customresourcedefinitions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Customresourcedefinitions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes customresourcedefinitions",
+ "operation": "Creates/Updates customresourcedefinitions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Customresourcedefinitions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes customresourcedefinitions",
+ "operation": "Deletes/DeletesCollection customresourcedefinitions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Customresourcedefinitions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservices",
+ "operation": "Gets/List apiservices resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiservices"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes apiservices",
+ "operation": "Creates/Updates apiservices resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiservices"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes apiservices",
+ "operation": "Deletes/DeletesCollection apiservices resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiservices"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads controllerrevisions",
+ "operation": "Gets/List controllerrevisions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Controllerrevisions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes controllerrevisions",
+ "operation": "Creates/Updates controllerrevisions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Controllerrevisions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes controllerrevisions",
+ "operation": "Deletes/DeletesCollection controllerrevisions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Controllerrevisions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads daemonsets",
+ "operation": "Gets/List daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes daemonsets",
+ "operation": "Creates/Updates daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes daemonsets",
+ "operation": "Deletes/DeletesCollection daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads deployments",
+ "operation": "Gets/List deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes deployments",
+ "operation": "Creates/Updates deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes deployments",
+ "operation": "Deletes/DeletesCollection deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads replicasets",
+ "operation": "Gets/List replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes replicasets",
+ "operation": "Creates/Updates replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes replicasets",
+ "operation": "Deletes/DeletesCollection replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads statefulsets",
+ "operation": "Gets/List statefulsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Statefulsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes statefulsets",
+ "operation": "Creates/Updates statefulsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Statefulsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes statefulsets",
+ "operation": "Deletes/DeletesCollection statefulsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Statefulsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes tokenreviews",
+ "operation": "Creates/Updates tokenreviews resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Tokenreviews"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes localsubjectaccessreviews",
+ "operation": "Creates/Updates localsubjectaccessreviews resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Localsubjectaccessreviews"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes selfsubjectaccessreviews",
+ "operation": "Creates/Updates selfsubjectaccessreviews resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Selfsubjectaccessreviews"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes selfsubjectrulesreviews",
+ "operation": "Creates/Updates selfsubjectrulesreviews resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Selfsubjectrulesreviews"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes subjectaccessreviews",
+ "operation": "Creates/Updates subjectaccessreviews resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Subjectaccessreviews"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads horizontalpodautoscalers",
+ "operation": "Gets/List horizontalpodautoscalers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Horizontalpodautoscalers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes horizontalpodautoscalers",
+ "operation": "Creates/Updates horizontalpodautoscalers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Horizontalpodautoscalers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes horizontalpodautoscalers",
+ "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Horizontalpodautoscalers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads cronjobs",
+ "operation": "Gets/List cronjobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Cronjobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes cronjobs",
+ "operation": "Creates/Updates cronjobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Cronjobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes cronjobs",
+ "operation": "Deletes/DeletesCollection cronjobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Cronjobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads jobs",
+ "operation": "Gets/List jobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Jobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes jobs",
+ "operation": "Creates/Updates jobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Jobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes jobs",
+ "operation": "Deletes/DeletesCollection jobs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Jobs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads certificatesigningrequests",
+ "operation": "Gets/List certificatesigningrequests resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Certificatesigningrequests"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes certificatesigningrequests",
+ "operation": "Creates/Updates certificatesigningrequests resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Certificatesigningrequests"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes certificatesigningrequests",
+ "operation": "Deletes/DeletesCollection certificatesigningrequests resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Certificatesigningrequests"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads leases",
+ "operation": "Gets/List leases resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Leases"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes leases",
+ "operation": "Creates/Updates leases resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Leases"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes leases",
+ "operation": "Deletes/DeletesCollection leases resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Leases"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes bindings",
+ "operation": "Creates/Updates bindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Bindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/bindings/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads componentstatuses",
+ "operation": "Gets/List componentstatuses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Componentstatuses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes componentstatuses",
+ "operation": "Creates/Updates componentstatuses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Componentstatuses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes componentstatuses",
+ "operation": "Deletes/DeletesCollection componentstatuses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Componentstatuses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads configmaps",
+ "operation": "Gets/List configmaps resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Configmaps"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/configmaps/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes configmaps",
+ "operation": "Creates/Updates configmaps resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Configmaps"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/configmaps/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes configmaps",
+ "operation": "Deletes/DeletesCollection configmaps resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Configmaps"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/configmaps/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads endpoints",
+ "operation": "Gets/List endpoints resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Endpoints"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/endpoints/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes endpoints",
+ "operation": "Creates/Updates endpoints resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Endpoints"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/endpoints/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes endpoints",
+ "operation": "Deletes/DeletesCollection endpoints resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Endpoints"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/endpoints/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads events",
+ "operation": "Gets/List events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes events",
+ "operation": "Creates/Updates events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes events",
+ "operation": "Deletes/DeletesCollection events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads limitranges",
+ "operation": "Gets/List limitranges resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Limitranges"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/limitranges/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes limitranges",
+ "operation": "Creates/Updates limitranges resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Limitranges"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/limitranges/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes limitranges",
+ "operation": "Deletes/DeletesCollection limitranges resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Limitranges"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/limitranges/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads namespaces",
+ "operation": "Gets/List namespaces resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Namespaces"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/namespaces/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes namespaces",
+ "operation": "Creates/Updates namespaces resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Namespaces"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/namespaces/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes namespaces",
+ "operation": "Deletes/DeletesCollection namespaces resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Namespaces"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/namespaces/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads nodes",
+ "operation": "Gets/List nodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Nodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/nodes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes nodes",
+ "operation": "Creates/Updates nodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Nodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/nodes/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes nodes",
+ "operation": "Deletes/DeletesCollection nodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Nodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/nodes/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads persistentvolumeclaims",
+ "operation": "Gets/List persistentvolumeclaims resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumeclaims"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes persistentvolumeclaims",
+ "operation": "Creates/Updates persistentvolumeclaims resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumeclaims"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes persistentvolumeclaims",
+ "operation": "Deletes/DeletesCollection persistentvolumeclaims resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumeclaims"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads persistentvolumes",
+ "operation": "Gets/List persistentvolumes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes persistentvolumes",
+ "operation": "Creates/Updates persistentvolumes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes persistentvolumes",
+ "operation": "Deletes/DeletesCollection persistentvolumes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Persistentvolumes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads pods",
+ "operation": "Gets/List pods resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Pods"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/pods/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes pods",
+ "operation": "Creates/Updates pods resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Pods"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/pods/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes pods",
+ "operation": "Deletes/DeletesCollection pods resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Pods"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/pods/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Exec into pods resource",
+ "operation": "Exec into pods resource ",
+ "provider": "Microsoft Container Service",
+ "resource": "Pods"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/pods/exec/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads podtemplates",
+ "operation": "Gets/List podtemplates resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podtemplates"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/podtemplates/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes podtemplates",
+ "operation": "Creates/Updates podtemplates resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podtemplates"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/podtemplates/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes podtemplates",
+ "operation": "Deletes/DeletesCollection podtemplates resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podtemplates"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads replicationcontrollers",
+ "operation": "Gets/List replicationcontrollers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicationcontrollers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes replicationcontrollers",
+ "operation": "Creates/Updates replicationcontrollers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicationcontrollers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes replicationcontrollers",
+ "operation": "Deletes/DeletesCollection replicationcontrollers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicationcontrollers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads resourcequotas",
+ "operation": "Gets/List resourcequotas resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Resourcequotas"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes resourcequotas",
+ "operation": "Creates/Updates resourcequotas resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Resourcequotas"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes resourcequotas",
+ "operation": "Deletes/DeletesCollection resourcequotas resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Resourcequotas"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads secrets",
+ "operation": "Gets/List secrets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Secrets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/secrets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes secrets",
+ "operation": "Creates/Updates secrets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Secrets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/secrets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes secrets",
+ "operation": "Deletes/DeletesCollection secrets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Secrets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/secrets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads serviceaccounts",
+ "operation": "Gets/List serviceaccounts resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Serviceaccounts"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes serviceaccounts",
+ "operation": "Creates/Updates serviceaccounts resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Serviceaccounts"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes serviceaccounts",
+ "operation": "Deletes/DeletesCollection serviceaccounts resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Serviceaccounts"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads services",
+ "operation": "Gets/List services resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Services"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/services/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes services",
+ "operation": "Creates/Updates services resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Services"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/services/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes services",
+ "operation": "Deletes/DeletesCollection services resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Services"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/services/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads events",
+ "operation": "Gets/List events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes events",
+ "operation": "Creates/Updates events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes events",
+ "operation": "Deletes/DeletesCollection events resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads daemonsets",
+ "operation": "Gets/List daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes daemonsets",
+ "operation": "Creates/Updates daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes daemonsets",
+ "operation": "Deletes/DeletesCollection daemonsets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Daemonsets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads deployments",
+ "operation": "Gets/List deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes deployments",
+ "operation": "Creates/Updates deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes deployments",
+ "operation": "Deletes/DeletesCollection deployments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Deployments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ingresses",
+ "operation": "Gets/List ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes ingresses",
+ "operation": "Creates/Updates ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes ingresses",
+ "operation": "Deletes/DeletesCollection ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads networkpolicies",
+ "operation": "Gets/List networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes networkpolicies",
+ "operation": "Creates/Updates networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes networkpolicies",
+ "operation": "Deletes/DeletesCollection networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads podsecuritypolicies",
+ "operation": "Gets/List podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes podsecuritypolicies",
+ "operation": "Creates/Updates podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes podsecuritypolicies",
+ "operation": "Deletes/DeletesCollection podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads replicasets",
+ "operation": "Gets/List replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes replicasets",
+ "operation": "Creates/Updates replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes replicasets",
+ "operation": "Deletes/DeletesCollection replicasets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Replicasets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads pods",
+ "operation": "Gets/List pods resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Pods"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads nodes",
+ "operation": "Gets/List nodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Nodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads networkpolicies",
+ "operation": "Gets/List networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes networkpolicies",
+ "operation": "Creates/Updates networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes networkpolicies",
+ "operation": "Deletes/DeletesCollection networkpolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networkpolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ingresses",
+ "operation": "Gets/List ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes ingresses",
+ "operation": "Creates/Updates ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes ingresses",
+ "operation": "Deletes/DeletesCollection ingresses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ingresses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads runtimeclasses",
+ "operation": "Gets/List runtimeclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Runtimeclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes runtimeclasses",
+ "operation": "Creates/Updates runtimeclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Runtimeclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes runtimeclasses",
+ "operation": "Deletes/DeletesCollection runtimeclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Runtimeclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads api",
+ "operation": "Gets/List api resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Api"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/api/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads api/v1",
+ "operation": "Gets/List api/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Api/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/api/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apis",
+ "operation": "Gets/List apis resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apis"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads admissionregistration.k8s.io",
+ "operation": "Gets/List admissionregistration.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Admissionregistration.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads admissionregistration.k8s.io/v1",
+ "operation": "Gets/List admissionregistration.k8s.io/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Admissionregistration.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads admissionregistration.k8s.io/v1beta1",
+ "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Admissionregistration.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiextensions.k8s.io",
+ "operation": "Gets/List apiextensions.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiextensions.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiextensions.k8s.io/v1",
+ "operation": "Gets/List apiextensions.k8s.io/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiextensions.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiextensions.k8s.io/v1beta1",
+ "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiextensions.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiregistration.k8s.io",
+ "operation": "Gets/List apiregistration.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiregistration.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiregistration.k8s.io/v1",
+ "operation": "Gets/List apiregistration.k8s.io/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiregistration.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiregistration.k8s.io/v1beta1",
+ "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apiregistration.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apps",
+ "operation": "Gets/List apps resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apps"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apps/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apps/v1",
+ "operation": "Gets/List apps/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apps/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apps/v1beta1",
+ "operation": "Gets/List apps/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apps/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apps/v1beta2",
+ "operation": "Gets/List apps/v1beta2 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Apps/V1beta2"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authentication.k8s.io",
+ "operation": "Gets/List authentication.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authentication.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authentication.k8s.io/v1",
+ "operation": "Gets/List authentication.k8s.io/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authentication.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authentication.k8s.io/v1beta1",
+ "operation": "Gets/List authentication.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authentication.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authorization.k8s.io",
+ "operation": "Gets/List authorization.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authorization.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authorization.k8s.io/v1",
+ "operation": "Gets/List authorization.k8s.io/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authorization.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads authorization.k8s.io/v1beta1",
+ "operation": "Gets/List authorization.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Authorization.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoscaling",
+ "operation": "Gets/List autoscaling resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Autoscaling"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoscaling/v1",
+ "operation": "Gets/List autoscaling/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Autoscaling/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoscaling/v2beta1",
+ "operation": "Gets/List autoscaling/v2beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Autoscaling/V2beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoscaling/v2beta2",
+ "operation": "Gets/List autoscaling/v2beta2 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Autoscaling/V2beta2"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads batch",
+ "operation": "Gets/List batch resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Batch"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/batch/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads batch/v1",
+ "operation": "Gets/List batch/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Batch/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads batch/v1beta1",
+ "operation": "Gets/List batch/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Batch/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads certificates.k8s.io",
+ "operation": "Gets/List certificates.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Certificates.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads certificates.k8s.io/v1beta1",
+ "operation": "Gets/List certificates.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Certificates.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads coordination.k8s.io",
+ "operation": "Gets/List coordination.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Coordination.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads coordination/v1",
+ "operation": "Gets/List coordination/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Coordination.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads coordination.k8s.io/v1beta1",
+ "operation": "Gets/List coordination.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Coordination.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads events.k8s.io",
+ "operation": "Gets/List events.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads events.k8s.io/v1beta1",
+ "operation": "Gets/List events.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Events.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads extensions",
+ "operation": "Gets/List extensions resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Extensions"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads extensions/v1beta1",
+ "operation": "Gets/List extensions/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Extensions/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads metrics.k8s.io",
+ "operation": "Gets/List metrics.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Metrics.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads metrics.k8s.io/v1beta1",
+ "operation": "Gets/List metrics.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Metrics.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads networking.k8s.io",
+ "operation": "Gets/List networking.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networking.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads networking/v1",
+ "operation": "Gets/List networking/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networking.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads networking.k8s.io/v1beta1",
+ "operation": "Gets/List networking.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Networking.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads node.k8s.io",
+ "operation": "Gets/List node.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Node.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads node.k8s.io/v1beta1",
+ "operation": "Gets/List node.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Node.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads policy",
+ "operation": "Gets/List policy resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Policy"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/policy/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads policy/v1beta1",
+ "operation": "Gets/List policy/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Policy/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads rbac.authorization.k8s.io",
+ "operation": "Gets/List rbac.authorization.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rbac.Authorization.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads rbac.authorization/v1",
+ "operation": "Gets/List rbac.authorization/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rbac.Authorization.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads rbac.authorization.k8s.io/v1beta1",
+ "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rbac.Authorization.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads scheduling.k8s.io",
+ "operation": "Gets/List scheduling.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Scheduling.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads scheduling/v1",
+ "operation": "Gets/List scheduling/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Scheduling.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads scheduling.k8s.io/v1beta1",
+ "operation": "Gets/List scheduling.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Scheduling.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads storage.k8s.io",
+ "operation": "Gets/List storage.k8s.io resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storage.K8s.Io"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads storage/v1",
+ "operation": "Gets/List storage/v1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storage.K8s.Io/V1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads storage.k8s.io/v1beta1",
+ "operation": "Gets/List storage.k8s.io/v1beta1 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storage.K8s.Io/V1beta1"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads healthz",
+ "operation": "Gets/List healthz resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoregister-completion",
+ "operation": "Gets/List autoregister-completion resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Autoregister-Completion"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads etcd",
+ "operation": "Gets/List etcd resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Etcd"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads log",
+ "operation": "Gets/List log resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Log"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/log/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ping",
+ "operation": "Gets/List ping resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Ping"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-openapi-controller",
+ "operation": "Gets/List apiservice-openapi-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-registration-controller",
+ "operation": "Gets/List apiservice-registration-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-status-available-controller",
+ "operation": "Gets/List apiservice-status-available-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-controller",
+ "operation": "Gets/List bootstrap-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Bootstrap-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ca-registration",
+ "operation": "Gets/List ca-registration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Ca-Registration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads crd-informer-synced",
+ "operation": "Gets/List crd-informer-synced resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Crd-Informer-Synced"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads generic-apiserver-start-informers",
+ "operation": "Gets/List generic-apiserver-start-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads kube-apiserver-autoregistration",
+ "operation": "Gets/List kube-apiserver-autoregistration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-roles",
+ "operation": "Gets/List bootstrap-roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Bootstrap-Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-system-priority-classes",
+ "operation": "Gets/List bootstrap-system-priority-classes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-controllers",
+ "operation": "Gets/List start-apiextensions-controllers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-informers",
+ "operation": "Gets/List start-apiextensions-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-aggregator-informers",
+ "operation": "Gets/List start-kube-aggregator-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-apiserver-admission-initializer",
+ "operation": "Gets/List start-kube-apiserver-admission-initializer resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads livez",
+ "operation": "Gets/List livez resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoregister-completion",
+ "operation": "Gets/List autoregister-completion resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Autoregister-Completion"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads etcd",
+ "operation": "Gets/List etcd resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Etcd"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads log",
+ "operation": "Gets/List log resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Log"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/log/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ping",
+ "operation": "Gets/List ping resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Ping"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/ping/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-openapi-controller",
+ "operation": "Gets/List apiservice-openapi-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-registration-controller",
+ "operation": "Gets/List apiservice-registration-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Apiservice-Registration-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-status-available-controller",
+ "operation": "Gets/List apiservice-status-available-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-controller",
+ "operation": "Gets/List bootstrap-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Bootstrap-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ca-registration",
+ "operation": "Gets/List ca-registration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Ca-Registration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads crd-informer-synced",
+ "operation": "Gets/List crd-informer-synced resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Crd-Informer-Synced"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads generic-apiserver-start-informers",
+ "operation": "Gets/List generic-apiserver-start-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads kube-apiserver-autoregistration",
+ "operation": "Gets/List kube-apiserver-autoregistration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-roles",
+ "operation": "Gets/List bootstrap-roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Bootstrap-Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-system-priority-classes",
+ "operation": "Gets/List bootstrap-system-priority-classes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-controllers",
+ "operation": "Gets/List start-apiextensions-controllers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-informers",
+ "operation": "Gets/List start-apiextensions-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Start-Apiextensions-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-aggregator-informers",
+ "operation": "Gets/List start-kube-aggregator-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-apiserver-admission-initializer",
+ "operation": "Gets/List start-kube-apiserver-admission-initializer resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads logs",
+ "operation": "Gets/List logs resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Logs"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/logs/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads metrics",
+ "operation": "Gets/List metrics resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Metrics"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/metrics/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads v2",
+ "operation": "Gets/List v2 resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Openapi/V2"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads readyz",
+ "operation": "Gets/List readyz resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads autoregister-completion",
+ "operation": "Gets/List autoregister-completion resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Autoregister-Completion"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads etcd",
+ "operation": "Gets/List etcd resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Etcd"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads log",
+ "operation": "Gets/List log resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Log"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/log/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ping",
+ "operation": "Gets/List ping resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Ping"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-openapi-controller",
+ "operation": "Gets/List apiservice-openapi-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-registration-controller",
+ "operation": "Gets/List apiservice-registration-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads apiservice-status-available-controller",
+ "operation": "Gets/List apiservice-status-available-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-controller",
+ "operation": "Gets/List bootstrap-controller resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Bootstrap-Controller"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ca-registration",
+ "operation": "Gets/List ca-registration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Ca-Registration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads crd-informer-synced",
+ "operation": "Gets/List crd-informer-synced resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Crd-Informer-Synced"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads generic-apiserver-start-informers",
+ "operation": "Gets/List generic-apiserver-start-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads kube-apiserver-autoregistration",
+ "operation": "Gets/List kube-apiserver-autoregistration resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-roles",
+ "operation": "Gets/List bootstrap-roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Bootstrap-Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads bootstrap-system-priority-classes",
+ "operation": "Gets/List bootstrap-system-priority-classes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-controllers",
+ "operation": "Gets/List start-apiextensions-controllers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-apiextensions-informers",
+ "operation": "Gets/List start-apiextensions-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-aggregator-informers",
+ "operation": "Gets/List start-kube-aggregator-informers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads start-kube-apiserver-admission-initializer",
+ "operation": "Gets/List start-kube-apiserver-admission-initializer resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads shutdown",
+ "operation": "Gets/List shutdown resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Readyz/Shutdown"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads resetMetrics",
+ "operation": "Gets/List resetMetrics resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Resetmetrics"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads swagger-ui",
+ "operation": "Gets/List swagger-ui resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Swagger-Ui"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads swagger-api",
+ "operation": "Gets/List swagger-api resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Swagger-Api"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/swagger-api/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads ui",
+ "operation": "Gets/List ui resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Ui"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/ui/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads version",
+ "operation": "Gets/List version resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Version"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/version/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads poddisruptionbudgets",
+ "operation": "Gets/List poddisruptionbudgets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Poddisruptionbudgets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes poddisruptionbudgets",
+ "operation": "Creates/Updates poddisruptionbudgets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Poddisruptionbudgets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes poddisruptionbudgets",
+ "operation": "Deletes/DeletesCollection poddisruptionbudgets resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Poddisruptionbudgets"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads podsecuritypolicies",
+ "operation": "Gets/List podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes podsecuritypolicies",
+ "operation": "Creates/Updates podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes podsecuritypolicies",
+ "operation": "Deletes/DeletesCollection podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads clusterrolebindings",
+ "operation": "Gets/List clusterrolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterrolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes clusterrolebindings",
+ "operation": "Creates/Updates clusterrolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterrolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes clusterrolebindings",
+ "operation": "Deletes/DeletesCollection clusterrolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterrolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads clusterroles",
+ "operation": "Gets/List clusterroles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterroles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes clusterroles",
+ "operation": "Creates/Updates clusterroles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterroles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes clusterroles",
+ "operation": "Deletes/DeletesCollection clusterroles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterroles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads rolebindings",
+ "operation": "Gets/List rolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes rolebindings",
+ "operation": "Creates/Updates rolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes rolebindings",
+ "operation": "Deletes/DeletesCollection rolebindings resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Rolebindings"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads roles",
+ "operation": "Gets/List roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes roles",
+ "operation": "Creates/Updates roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes roles",
+ "operation": "Deletes/DeletesCollection roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads priorityclasses",
+ "operation": "Gets/List priorityclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Priorityclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes priorityclasses",
+ "operation": "Creates/Updates priorityclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Priorityclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes priorityclasses",
+ "operation": "Deletes/DeletesCollection priorityclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Priorityclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Use action on podsecuritypolicies",
+ "operation": "Use podsecuritypolicies resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Podsecuritypolicies"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Binds clusterroles",
+ "operation": "Bind clusterroles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterroles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Escalates",
+ "operation": "Escalate clusterroles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Clusterroles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Binds roles",
+ "operation": "Bind roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Escalates roles",
+ "operation": "Escalate roles resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Roles"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Impersonate serviceaccounts",
+ "operation": "Impersonate serviceaccounts resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Serviceaccounts"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Impersonate users",
+ "operation": "Impersonate users resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Users"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Impersonate groups",
+ "operation": "Impersonate groups resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Groups"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Impersonate userextras",
+ "operation": "Impersonate userextras resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Userextras"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads storageclasses",
+ "operation": "Gets/List storageclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storageclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes storageclasses",
+ "operation": "Creates/Updates storageclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storageclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes storageclasses",
+ "operation": "Deletes/DeletesCollection storageclasses resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Storageclasses"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads volumeattachments",
+ "operation": "Gets/List volumeattachments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Volumeattachments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes volumeattachments",
+ "operation": "Creates/Updates volumeattachments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Volumeattachments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes volumeattachments",
+ "operation": "Deletes/DeletesCollection volumeattachments resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Volumeattachments"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads csidrivers",
+ "operation": "Gets/List csidrivers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csidrivers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes csidrivers",
+ "operation": "Creates/Updates csidrivers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csidrivers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes csidrivers",
+ "operation": "Deletes/DeletesCollection csidrivers resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csidrivers"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Reads csinodes",
+ "operation": "Gets/List csinodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csinodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Writes csinodes",
+ "operation": "Creates/Updates csinodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csinodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Deletes csinodes",
+ "operation": "Deletes/DeletesCollection csinodes resource",
+ "provider": "Microsoft Container Service",
+ "resource": "Csinodes"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Gets the available metrics for Managed Cluster",
+ "operation": "Read Managed Cluster metric definitions",
+ "provider": "Microsoft Container Service",
+ "resource": "The metric definition of Managed Cluster"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Gets the available logs for Managed Cluster",
+ "operation": "Read Managed Cluster log definitions",
+ "provider": "Microsoft Container Service",
+ "resource": "The log definition of Managed Cluster"
+ },
+ "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read",
+ "origin": "system"
+ },
+ {
+ "display": {
+ "description": "Get a Open Shift Managed Cluster",
+ "operation": "Get Open Shift Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Managed Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftManagedClusters/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new Open Shift Managed Cluster or updates an existing one",
+ "operation": "Create or Update Open Shift Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Managed Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftManagedClusters/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Delete a Open Shift Managed Cluster",
+ "operation": "Delete Open Shift Managed Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Managed Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftManagedClusters/delete",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Get a Open Shift Cluster",
+ "operation": "Get Open Shift Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftClusters/read",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Creates a new Open Shift Cluster or updates an existing one",
+ "operation": "Create or Update Open Shift Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftClusters/write",
+ "origin": "user,system"
+ },
+ {
+ "display": {
+ "description": "Delete a Open Shift Cluster",
+ "operation": "Delete Open Shift Cluster",
+ "provider": "Microsoft Container Service",
+ "resource": "Open Shift Cluster"
+ },
+ "name": "Microsoft.ContainerService/openShiftClusters/delete",
+ "origin": "user,system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json
new file mode 100644
index 000000000000..2694f5924392
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json
@@ -0,0 +1,242 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "category": "azure-resource-management",
+ "endpoints": [
+ {
+ "domainName": "management.azure.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "login.microsoftonline.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "images",
+ "endpoints": [
+ {
+ "domainName": "mcr.microsoft.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "*.data.mcr.microsoft.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https",
+ "description": "mcr cdn"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "artifacts",
+ "endpoints": [
+ {
+ "domainName": "packages.microsoft.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "acs-mirror.azureedge.net",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "time-sync",
+ "endpoints": [
+ {
+ "domainName": "ntp.ubuntu.com",
+ "endpointDetails": [
+ {
+ "port": 123,
+ "protocol": "UDP"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "ubuntu-optional",
+ "endpoints": [
+ {
+ "domainName": "security.ubuntu.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ },
+ {
+ "domainName": "azure.archive.ubuntu.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ },
+ {
+ "domainName": "changelogs.ubuntu.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "gpu",
+ "endpoints": [
+ {
+ "domainName": "nvidia.github.io",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "us.download.nvidia.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "apt.dockerproject.org",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "windows",
+ "endpoints": [
+ {
+ "domainName": "onegetcdn.azureedge.net",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "go.microsoft.com",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ },
+ {
+ "domainName": "*.mp.microsoft.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ },
+ {
+ "domainName": "www.msftconnecttest.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ },
+ {
+ "domainName": "ctldl.windowsupdate.com",
+ "endpointDetails": [
+ {
+ "port": 80,
+ "protocol": "Http"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "apiserver",
+ "endpoints": [
+ {
+ "domainName": "*.azmk8s.io",
+ "endpointDetails": [
+ {
+ "port": 443,
+ "protocol": "Https"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "tunnel-classic",
+ "endpoints": [
+ {
+ "domainName": "*.azmk8s.io",
+ "endpointDetails": [
+ {
+ "port": 9000,
+ "protocol": "TCP"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsDelete.json
new file mode 100644
index 000000000000..db63bc9b776e
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsDelete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "privateEndpointConnectionName": "privateendpointconnection1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsGet.json
new file mode 100644
index 000000000000..2540e7779fb0
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "privateEndpointConnectionName": "privateendpointconnection1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1",
+ "name": "privateendpointconnection1",
+ "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsList.json
new file mode 100644
index 000000000000..a2b1b4cdf436
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsList.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1",
+ "name": "privateendpointconnection1",
+ "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json
new file mode 100644
index 000000000000..b9e53b196507
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateEndpointConnectionsUpdate.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "privateEndpointConnectionName": "privateendpointconnection1",
+ "parameters": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1",
+ "name": "privateendpointconnection1",
+ "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateLinkResourcesList.json
new file mode 100644
index 000000000000..89d690bcc791
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/PrivateLinkResourcesList.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "management",
+ "type": "Microsoft.ContainerService/managedClusters/privateLinkResources",
+ "groupId": "management",
+ "requiredMembers": [
+ "management"
+ ],
+ "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ResolvePrivateLinkServiceId.json
new file mode 100644
index 000000000000..02f1e1bd4c75
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/ResolvePrivateLinkServiceId.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "parameters": {
+ "name": "management"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName"
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandRequest.json
new file mode 100644
index 000000000000..63fc047c0447
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandRequest.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "requestPayload": {
+ "command": "kubectl apply -f ns.yaml",
+ "context": "",
+ "clusterToken": ""
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2022-11-02-preview"
+ }
+ },
+ "200": {
+ "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE",
+ "body": {
+ "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
+ "properties": {
+ "provisioningState": "succeeded",
+ "exitCode": 0,
+ "startedAt": "2021-02-17T00:28:20Z",
+ "finishedAt": "2021-02-17T00:28:33Z",
+ "logs": "namespace dummy created"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultFailed.json
new file mode 100644
index 000000000000..cf0681cf201e
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultFailed.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2022-11-02-preview"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
+ "properties": {
+ "provisioningState": "failed",
+ "reason": "ImagePullBackoff"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultSucceed.json
new file mode 100644
index 000000000000..615845857a04
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/RunCommandResultSucceed.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2022-11-02-preview"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9",
+ "properties": {
+ "provisioningState": "succeeded",
+ "exitCode": 0,
+ "startedAt": "2021-02-17T00:28:20Z",
+ "finishedAt": "2021-02-17T00:28:33Z",
+ "logs": "namespace dummy created"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsCreate.json
new file mode 100644
index 000000000000..5fdcee741ac1
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsCreate.json
@@ -0,0 +1,80 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1",
+ "parameters": {
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsDelete.json
new file mode 100644
index 000000000000..18a77874eaf8
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsDelete.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsGet.json
new file mode 100644
index 000000000000..159772454f6a
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsGet.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsList.json
new file mode 100644
index 000000000000..6b48fba2a39f
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsList.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsListByResourceGroup.json
new file mode 100644
index 000000000000..1aadfef31ff0
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsListByResourceGroup.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsUpdateTags.json
new file mode 100644
index 000000000000..10aa8a23cd55
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/SnapshotsUpdateTags.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "snapshot1",
+ "parameters": {
+ "tags": {
+ "key2": "new-val2",
+ "key3": "val3"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "snapshot1",
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1",
+ "type": "Microsoft.ContainerService/Snapshots",
+ "location": "westus",
+ "tags": {
+ "key1": "val1",
+ "key2": "val2"
+ },
+ "systemData": {
+ "createdBy": "user1",
+ "createdByType": "User",
+ "createdAt": "2021-08-09T20:13:23.298420761Z"
+ },
+ "properties": {
+ "creationData": {
+ "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0"
+ },
+ "snapshotType": "NodePool",
+ "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11",
+ "kubernetesVersion": "1.20.5",
+ "osType": "Linux",
+ "osSku": "Ubuntu",
+ "vmSize": "Standard_D2s_v3",
+ "enableFIPS": false
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json
new file mode 100644
index 000000000000..de273e2bd361
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "trustedAccessRoleBindingName": "binding1",
+ "trustedAccessRoleBinding": {
+ "properties": {
+ "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c",
+ "roles": [
+ "Microsoft.MachineLearningServices/workspaces/reader",
+ "Microsoft.MachineLearningServices/workspaces/writer"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1",
+ "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "name": "binding1",
+ "properties": {
+ "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c",
+ "roles": [
+ "Microsoft.MachineLearningServices/workspaces/reader",
+ "Microsoft.MachineLearningServices/workspaces/writer"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json
new file mode 100644
index 000000000000..96f79b2efc03
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Delete.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "trustedAccessRoleBindingName": "binding1"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Get.json
new file mode 100644
index 000000000000..c255bbbb60a4
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_Get.json
@@ -0,0 +1,25 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1",
+ "trustedAccessRoleBindingName": "binding1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1",
+ "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "name": "binding1",
+ "properties": {
+ "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c",
+ "roles": [
+ "Microsoft.MachineLearningServices/workspaces/reader",
+ "Microsoft.MachineLearningServices/workspaces/writer"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_List.json
new file mode 100644
index 000000000000..f2ef063f21c3
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoleBindings_List.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "resourceGroupName": "rg1",
+ "resourceName": "clustername1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1",
+ "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings",
+ "name": "binding1",
+ "properties": {
+ "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c",
+ "roles": [
+ "Microsoft.MachineLearningServices/workspaces/reader",
+ "Microsoft.MachineLearningServices/workspaces/writer"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoles_List.json
new file mode 100644
index 000000000000..281360cbead8
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/examples/TrustedAccessRoles_List.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-11-02-preview",
+ "subscriptionId": "subid1",
+ "location": "westus2"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "sourceResourceType": "Microsoft.MachineLearningServices/workspaces",
+ "name": "reader",
+ "rules": [
+ {
+ "verbs": [
+ "get"
+ ],
+ "apiGroups": [
+ ""
+ ],
+ "resources": [
+ "pods"
+ ],
+ "resourceNames": [],
+ "nonResourceURLs": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/managedClusters.json
new file mode 100644
index 000000000000..336dafa6f3ba
--- /dev/null
+++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-11-02-preview/managedClusters.json
@@ -0,0 +1,7852 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ContainerServiceClient",
+ "description": "The Container Service Client.",
+ "version": "2022-11-02-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/providers/Microsoft.ContainerService/operations": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "Operations_List",
+ "summary": "Gets a list of operations.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "List available operations for the container service resource provider": {
+ "$ref": "./examples/Operation_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_GetOSOptions",
+ "summary": "Gets supported OS options in the specified subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceTypeParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OSOptionProfile"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Container Service OS Options": {
+ "$ref": "./examples/ContainerServiceGetOSOptions.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_List",
+ "summary": "Gets a list of managed clusters in the specified subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Managed Clusters": {
+ "$ref": "./examples/ManagedClustersList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ListByResourceGroup",
+ "summary": "Lists managed clusters in the specified subscription and resource group.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get Managed Clusters by Resource Group": {
+ "$ref": "./examples/ManagedClustersListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_GetUpgradeProfile",
+ "summary": "Gets the upgrade profile of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterUpgradeProfile"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Upgrade Profile for Managed Cluster": {
+ "$ref": "./examples/ManagedClustersGetUpgradeProfile.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": {
+ "post": {
+ "deprecated": true,
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_GetAccessProfile",
+ "summary": "Gets an access profile of a managed cluster.",
+ "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the role for managed cluster accessProfile resource."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterAccessProfile"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster": {
+ "$ref": "./examples/ManagedClustersGetAccessProfile.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ListClusterAdminCredentials",
+ "summary": "Lists the admin credentials of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerFqdnParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CredentialResults"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster": {
+ "$ref": "./examples/ManagedClustersListClusterCredentialResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ListClusterUserCredentials",
+ "summary": "Lists the user credentials of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerFqdnParameter"
+ },
+ {
+ "$ref": "#/parameters/CredentialFormatParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CredentialResults"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster": {
+ "$ref": "./examples/ManagedClustersListClusterCredentialResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials",
+ "summary": "Lists the cluster monitoring user credentials of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ServerFqdnParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CredentialResults"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster": {
+ "$ref": "./examples/ManagedClustersListClusterCredentialResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_Get",
+ "summary": "Gets a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedCluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster": {
+ "$ref": "./examples/ManagedClustersGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_CreateOrUpdate",
+ "summary": "Creates or updates a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ManagedCluster"
+ },
+ "description": "The managed cluster to create or update."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedCluster"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ManagedCluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create/Update Managed Cluster": {
+ "$ref": "./examples/ManagedClustersCreate_Update.json"
+ },
+ "Create/Update AAD Managed Cluster with EnableAzureRBAC": {
+ "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json"
+ },
+ "Create/Update Managed Cluster with EnableNamespaceResources": {
+ "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json"
+ },
+ "Create Managed Cluster with PPG": {
+ "$ref": "./examples/ManagedClustersCreate_PPG.json"
+ },
+ "Create Managed Cluster with OSSKU": {
+ "$ref": "./examples/ManagedClustersCreate_OSSKU.json"
+ },
+ "Create Managed Cluster with GPUMIG": {
+ "$ref": "./examples/ManagedClustersCreate_GPUMIG.json"
+ },
+ "Create/Update Managed Cluster with EnableAHUB": {
+ "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json"
+ },
+ "Create Managed Cluster with EncryptionAtHost enabled": {
+ "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json"
+ },
+ "Create Managed Cluster with UltraSSD enabled": {
+ "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json"
+ },
+ "Create Managed Cluster with PodIdentity enabled": {
+ "$ref": "./examples/ManagedClustersCreate_PodIdentity.json"
+ },
+ "Create Managed Private Cluster with fqdn subdomain specified": {
+ "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json"
+ },
+ "Create Managed Private Cluster with Public FQDN specified": {
+ "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json"
+ },
+ "Create Managed Cluster with RunCommand disabled": {
+ "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json"
+ },
+ "Create Managed Cluster with Node Public IP Prefix": {
+ "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json"
+ },
+ "Create Managed Cluster with Azure KeyVault Secrets Provider Addon": {
+ "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json"
+ },
+ "Create Managed Cluster with FIPS enabled OS": {
+ "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json"
+ },
+ "Create Managed Cluster with HTTP proxy configured": {
+ "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json"
+ },
+ "Create Managed Cluster with Security Profile configured": {
+ "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json"
+ },
+ "Create Managed Cluster with Web App Routing Ingress Profile configured": {
+ "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json"
+ },
+ "Create Managed Cluster with AKS-managed NAT gateway as outbound type": {
+ "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json"
+ },
+ "Create Managed Cluster with user-assigned NAT gateway as outbound type": {
+ "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json"
+ },
+ "Create Managed Cluster using an agent pool snapshot": {
+ "$ref": "./examples/ManagedClustersCreate_Snapshot.json"
+ },
+ "Create Managed Cluster using a managed cluster snapshot": {
+ "$ref": "./examples/ManagedClustersCreate_MCSnapshot.json"
+ },
+ "Create/Update Managed Cluster with Windows gMSA enabled": {
+ "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json"
+ },
+ "Create/Update Managed Cluster with dual-stack networking": {
+ "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json"
+ },
+ "Associate Managed Cluster with Capacity Reservation Group": {
+ "$ref": "./examples/ManagedClustersAssociate_CRG.json"
+ },
+ "Create Managed Cluster with Dedicated Host Group": {
+ "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json"
+ },
+ "Create Managed Cluster with CustomCATrustCertificates populated and CustomCATrust enabled": {
+ "$ref": "./examples/ManagedClustersCreate_EnableCustomCATrust.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_UpdateTags",
+ "summary": "Updates tags on a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsObject"
+ },
+ "description": "Parameters supplied to the Update Managed Cluster Tags operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedCluster"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update Managed Cluster Tags": {
+ "$ref": "./examples/ManagedClustersUpdateTags.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_Delete",
+ "summary": "Deletes a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Managed Cluster": {
+ "$ref": "./examples/ManagedClustersDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": {
+ "get": {
+ "tags": [
+ "MaintenanceConfigurations"
+ ],
+ "operationId": "MaintenanceConfigurations_ListByManagedCluster",
+ "summary": "Gets a list of maintenance configurations in the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MaintenanceConfigurationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List maintenance configurations by Managed Cluster": {
+ "$ref": "./examples/MaintenanceConfigurationsList.json"
+ },
+ "List maintenance configurations configured with maintenance window by Managed Cluster": {
+ "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": {
+ "get": {
+ "tags": [
+ "MaintenanceConfigurations"
+ ],
+ "operationId": "MaintenanceConfigurations_Get",
+ "summary": "Gets the specified maintenance configuration of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "configName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the maintenance configuration."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MaintenanceConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Maintenance Configuration": {
+ "$ref": "./examples/MaintenanceConfigurationsGet.json"
+ },
+ "Get Maintenance Configuration Configured With Maintenance Window": {
+ "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "MaintenanceConfigurations"
+ ],
+ "operationId": "MaintenanceConfigurations_CreateOrUpdate",
+ "summary": "Creates or updates a maintenance configuration in the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "configName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the maintenance configuration."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MaintenanceConfiguration"
+ },
+ "description": "The maintenance configuration to create or update."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MaintenanceConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "Create/Update Maintenance Configuration": {
+ "$ref": "./examples/MaintenanceConfigurationsCreate_Update.json"
+ },
+ "Create/Update Maintenance Configuration with Maintenance Window": {
+ "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "MaintenanceConfigurations"
+ ],
+ "operationId": "MaintenanceConfigurations_Delete",
+ "summary": "Deletes a maintenance configuration.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "configName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the maintenance configuration."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": false,
+ "x-ms-examples": {
+ "Delete Maintenance Configuration": {
+ "$ref": "./examples/MaintenanceConfigurationsDelete.json"
+ },
+ "Delete Maintenance Configuration For Node OS Upgrade": {
+ "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": {
+ "post": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_AbortLatestOperation",
+ "summary": "Aborts last operation running on agent pool.",
+ "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-z][a-z0-9]{0,11}$",
+ "minLength": 1,
+ "maxLength": 12,
+ "description": "The name of the agent pool."
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "NoContent"
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Abort operation on agent pool": {
+ "$ref": "./examples/AgentPoolsAbortOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": {
+ "get": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_List",
+ "summary": "Gets a list of agent pools in the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AgentPoolListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Agent Pools by Managed Cluster": {
+ "$ref": "./examples/AgentPoolsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": {
+ "get": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_Get",
+ "summary": "Gets the specified managed cluster agent pool.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-z][a-z0-9]{0,11}$",
+ "minLength": 1,
+ "maxLength": 12,
+ "description": "The name of the agent pool."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AgentPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Agent Pool": {
+ "$ref": "./examples/AgentPoolsGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_CreateOrUpdate",
+ "summary": "Creates or updates an agent pool in the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the agent pool."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AgentPool"
+ },
+ "description": "The agent pool to create or update."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AgentPool"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/AgentPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create/Update Agent Pool": {
+ "$ref": "./examples/AgentPoolsCreate_Update.json"
+ },
+ "Update Agent Pool": {
+ "$ref": "./examples/AgentPools_Update.json"
+ },
+ "Create Spot Agent Pool": {
+ "$ref": "./examples/AgentPoolsCreate_Spot.json"
+ },
+ "Create Agent Pool with PPG": {
+ "$ref": "./examples/AgentPoolsCreate_PPG.json"
+ },
+ "Create Agent Pool with OSSKU": {
+ "$ref": "./examples/AgentPoolsCreate_OSSKU.json"
+ },
+ "Create Agent Pool with Windows OSSKU": {
+ "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json"
+ },
+ "Create Windows Agent Pool with disabling OutboundNAT": {
+ "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json"
+ },
+ "Create Agent Pool with GPUMIG": {
+ "$ref": "./examples/AgentPoolsCreate_GPUMIG.json"
+ },
+ "Create Agent Pool with Ephemeral OS Disk": {
+ "$ref": "./examples/AgentPoolsCreate_Ephemeral.json"
+ },
+ "Create Agent Pool with KubeletConfig and LinuxOSConfig": {
+ "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json"
+ },
+ "Create Agent Pool with EncryptionAtHost enabled": {
+ "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json"
+ },
+ "Create Agent Pool with UltraSSD enabled": {
+ "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json"
+ },
+ "Create Agent Pool with FIPS enabled OS": {
+ "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json"
+ },
+ "Create Agent Pool using an agent pool snapshot": {
+ "$ref": "./examples/AgentPoolsCreate_Snapshot.json"
+ },
+ "Create Agent Pool with Krustlet and the WASI runtime": {
+ "$ref": "./examples/AgentPoolsCreate_WasmWasi.json"
+ },
+ "Create Agent Pool with Message of the Day": {
+ "$ref": "./examples/AgentPoolsCreate_MessageOfTheDay.json"
+ },
+ "Stop Agent Pool": {
+ "$ref": "./examples/AgentPools_Stop.json"
+ },
+ "Start Agent Pool": {
+ "$ref": "./examples/AgentPools_Start.json"
+ },
+ "Associate Agent Pool with Capacity Reservation Group": {
+ "$ref": "./examples/AgentPoolsAssociate_CRG.json"
+ },
+ "Create Agent Pool with Dedicated Host Group": {
+ "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json"
+ },
+ "Create Agent Pool with CustomCATrust enabled": {
+ "$ref": "./examples/AgentPoolsCreate_EnableCustomCATrust.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_Delete",
+ "summary": "Deletes an agent pool in the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the agent pool."
+ },
+ {
+ "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Agent Pool": {
+ "$ref": "./examples/AgentPoolsDelete.json"
+ },
+ "Delete Agent Pool by ignoring PodDisruptionBudget": {
+ "$ref": "./examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": {
+ "get": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_GetUpgradeProfile",
+ "summary": "Gets the upgrade profile for an agent pool.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-z][a-z0-9]{0,11}$",
+ "minLength": 1,
+ "maxLength": 12,
+ "description": "The name of the agent pool."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AgentPoolUpgradeProfile"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Upgrade Profile for Agent Pool": {
+ "$ref": "./examples/AgentPoolsGetUpgradeProfile.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": {
+ "get": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_GetAvailableAgentPoolVersions",
+ "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.",
+ "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AgentPoolAvailableVersions"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get available versions for agent pool": {
+ "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ResetServicePrincipalProfile",
+ "summary": "Reset the Service Principal Profile of a managed cluster.",
+ "description": "This action cannot be performed on a cluster that is not using a service principal",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterServicePrincipalProfile"
+ },
+ "description": "The service principal profile to set on the managed cluster."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Reset Service Principal Profile": {
+ "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ResetAADProfile",
+ "summary": "Reset the AAD Profile of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterAADProfile"
+ },
+ "description": "The AAD profile to set on the Managed Cluster"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Reset AAD Profile": {
+ "$ref": "./examples/ManagedClustersResetAADProfile.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_AbortLatestOperation",
+ "summary": "Aborts last operation running on managed cluster.",
+ "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "NoContent"
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Abort operation on managed cluster": {
+ "$ref": "./examples/ManagedClustersAbortOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_RotateClusterCertificates",
+ "summary": "Rotates the certificates of a managed cluster.",
+ "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Rotate Cluster Certificates": {
+ "$ref": "./examples/ManagedClustersRotateClusterCertificates.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_RotateServiceAccountSigningKeys",
+ "summary": "Rotates the service account signing keys of a managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Rotate Cluster Service Account Signing Keys": {
+ "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_Stop",
+ "summary": "Stops a Managed Cluster",
+ "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Stop Managed Cluster": {
+ "$ref": "./examples/ManagedClustersStop.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_Start",
+ "summary": "Starts a previously stopped Managed Cluster",
+ "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Start Managed Cluster": {
+ "$ref": "./examples/ManagedClustersStart.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_List",
+ "summary": "Gets a list of private endpoint connections in the specified managed cluster.",
+ "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Private Endpoint Connections by Managed Cluster": {
+ "$ref": "./examples/PrivateEndpointConnectionsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Get",
+ "summary": "Gets the specified private endpoint connection.",
+ "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Private Endpoint Connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Update",
+ "summary": "Updates a private endpoint connection.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection."
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "The updated private endpoint connection."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update Private Endpoint Connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "operationId": "PrivateEndpointConnections_Delete",
+ "summary": "Deletes a private endpoint connection.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content -- The private endpoint connection does not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Private Endpoint Connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": {
+ "post": {
+ "tags": [
+ "AgentPools"
+ ],
+ "operationId": "AgentPools_UpgradeNodeImageVersion",
+ "summary": "Upgrades the node image version of an agent pool to the latest.",
+ "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "agentPoolName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[a-z][a-z0-9]{0,11}$",
+ "minLength": 1,
+ "maxLength": 12,
+ "description": "The name of the agent pool."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Azure-AsyncOperation": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ },
+ "schema": {
+ "$ref": "#/definitions/AgentPool"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Upgrade Agent Pool Node Image Version": {
+ "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "privateLinkResources"
+ ],
+ "operationId": "PrivateLinkResources_List",
+ "summary": "Gets a list of private link resources in the specified managed cluster.",
+ "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourcesListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Private Link Resources by Managed Cluster": {
+ "$ref": "./examples/PrivateLinkResourcesList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": {
+ "post": {
+ "tags": [
+ "resolvePrivateLinkServiceId"
+ ],
+ "operationId": "ResolvePrivateLinkServiceId_POST",
+ "summary": "Gets the private link service ID for the specified managed cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ },
+ "description": "Parameters required in order to resolve a private link service ID."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Resolve the Private Link Service ID for Managed Cluster": {
+ "$ref": "./examples/ResolvePrivateLinkServiceId.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": {
+ "post": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_RunCommand",
+ "summary": "Submits a command to run against the Managed Cluster.",
+ "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "requestPayload",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RunCommandRequest"
+ },
+ "description": "The run command request"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!",
+ "schema": {
+ "$ref": "#/definitions/RunCommandResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "submitNewCommand": {
+ "$ref": "./examples/RunCommandRequest.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_GetCommandResult",
+ "summary": "Gets the results of a command which has been run on the Managed Cluster.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "commandId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Id of the command."
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "command running in progress",
+ "headers": {
+ "Location": {
+ "description": "URL to query for status of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "command finished",
+ "schema": {
+ "$ref": "#/definitions/RunCommandResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "commandSucceedResult": {
+ "$ref": "./examples/RunCommandResultSucceed.json"
+ },
+ "commandFailedResult": {
+ "$ref": "./examples/RunCommandResultFailed.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": {
+ "get": {
+ "tags": [
+ "ManagedClusters"
+ ],
+ "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints",
+ "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.",
+ "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List OutboundNetworkDependenciesEndpoints by Managed Cluster": {
+ "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": {
+ "get": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_List",
+ "summary": "Gets a list of snapshots in the specified subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Snapshots": {
+ "$ref": "./examples/SnapshotsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": {
+ "get": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_ListByResourceGroup",
+ "summary": "Lists snapshots in the specified subscription and resource group.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Snapshots by Resource Group": {
+ "$ref": "./examples/SnapshotsListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": {
+ "get": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_Get",
+ "summary": "Gets a snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Snapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Snapshot": {
+ "$ref": "./examples/SnapshotsGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_CreateOrUpdate",
+ "summary": "Creates or updates a snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Snapshot"
+ },
+ "description": "The snapshot to create or update."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Snapshot"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/Snapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create/Update Snapshot": {
+ "$ref": "./examples/SnapshotsCreate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_UpdateTags",
+ "summary": "Updates tags on a snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsObject"
+ },
+ "description": "Parameters supplied to the Update snapshot Tags operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Snapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update Snapshot Tags": {
+ "$ref": "./examples/SnapshotsUpdateTags.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Snapshots"
+ ],
+ "operationId": "Snapshots_Delete",
+ "summary": "Deletes a snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete Snapshot": {
+ "$ref": "./examples/SnapshotsDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": {
+ "get": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_List",
+ "summary": "Gets a list of managed cluster snapshots in the specified subscription.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshotListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Managed Cluster Snapshots": {
+ "$ref": "./examples/ManagedClusterSnapshotsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": {
+ "get": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_ListByResourceGroup",
+ "summary": "Lists managed cluster snapshots in the specified subscription and resource group.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshotListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List Managed Cluster Snapshots by Resource Group": {
+ "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": {
+ "get": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_Get",
+ "summary": "Gets a managed cluster snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Managed Cluster Snapshot": {
+ "$ref": "./examples/ManagedClusterSnapshotsGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_CreateOrUpdate",
+ "summary": "Creates or updates a managed cluster snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ },
+ "description": "The managed cluster snapshot to create or update."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create/Update Managed Cluster Snapshot": {
+ "$ref": "./examples/ManagedClusterSnapshotsCreate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_UpdateTags",
+ "summary": "Updates tags on a managed cluster snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsObject"
+ },
+ "description": "Parameters supplied to the Update managed cluster snapshot Tags operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update Managed Cluster Snapshot Tags": {
+ "$ref": "./examples/ManagedClusterSnapshotsUpdateTags.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ManagedClusterSnapshots"
+ ],
+ "operationId": "ManagedClusterSnapshots_Delete",
+ "summary": "Deletes a managed cluster snapshot.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete Managed Cluster Snapshot": {
+ "$ref": "./examples/ManagedClusterSnapshotsDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": {
+ "get": {
+ "tags": [
+ "TrustedAccess"
+ ],
+ "operationId": "TrustedAccessRoles_List",
+ "summary": "List supported trusted access roles.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TrustedAccessRoleListResult"
+ }
+ },
+ "default": {
+ "description": "Error details",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List trusted access roles": {
+ "$ref": "./examples/TrustedAccessRoles_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": {
+ "get": {
+ "tags": [
+ "TrustedAccess"
+ ],
+ "operationId": "TrustedAccessRoleBindings_List",
+ "summary": "List trusted access role bindings.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TrustedAccessRoleBindingListResult"
+ }
+ },
+ "default": {
+ "description": "Error details",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List trusted access role bindings": {
+ "$ref": "./examples/TrustedAccessRoleBindings_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": {
+ "get": {
+ "tags": [
+ "TrustedAccess"
+ ],
+ "operationId": "TrustedAccessRoleBindings_Get",
+ "summary": "Get a trusted access role binding.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TrustedAccessRoleBinding"
+ }
+ },
+ "default": {
+ "description": "Error details",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a trusted access role binding": {
+ "$ref": "./examples/TrustedAccessRoleBindings_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "TrustedAccess"
+ ],
+ "operationId": "TrustedAccessRoleBindings_CreateOrUpdate",
+ "summary": "Create or update a trusted access role binding",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter"
+ },
+ {
+ "name": "trustedAccessRoleBinding",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TrustedAccessRoleBinding"
+ },
+ "description": "A trusted access role binding"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TrustedAccessRoleBinding"
+ }
+ },
+ "default": {
+ "description": "Error details",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a trusted access role binding": {
+ "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "TrustedAccess"
+ ],
+ "operationId": "TrustedAccessRoleBindings_Delete",
+ "summary": "Delete a trusted access role binding.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error details",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a trusted access role binding": {
+ "$ref": "./examples/TrustedAccessRoleBindings_Delete.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "OperationListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/OperationValue"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of operations"
+ }
+ },
+ "description": "The List Operation response."
+ },
+ "OperationValue": {
+ "type": "object",
+ "properties": {
+ "origin": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The origin of the operation."
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the operation."
+ },
+ "display": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OperationValueDisplay",
+ "description": "Describes the properties of a Operation Value Display."
+ }
+ },
+ "description": "Describes the properties of a Operation value."
+ },
+ "OperationValueDisplay": {
+ "type": "object",
+ "properties": {
+ "operation": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The display name of the operation."
+ },
+ "resource": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The display name of the resource the operation applies to."
+ },
+ "description": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The description of the operation."
+ },
+ "provider": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The resource provider for the operation."
+ }
+ },
+ "description": "Describes the properties of a Operation Value Display."
+ },
+ "SubResource": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource ID."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ }
+ },
+ "description": "Reference to another subresource.",
+ "x-ms-azure-resource": true
+ },
+ "TagsObject": {
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags."
+ }
+ },
+ "description": "Tags object for patch operations."
+ },
+ "ContainerServiceOSDisk": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 2048,
+ "minimum": 0,
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "ContainerServiceStorageProfile": {
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContainerServiceStorageProfileTypes",
+ "modelAsString": true
+ },
+ "enum": [
+ "StorageAccount",
+ "ManagedDisks"
+ ],
+ "description": "Specifies what kind of storage to use. If omitted, the default will be chosen on your behalf based on the choice of orchestrator."
+ },
+ "ContainerServiceVnetSubnetID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/virtualNetworks/subnets"
+ }
+ ]
+ },
+ "description": "specifies a subnet's resource id with subscription, resource group, vnet and subnet name"
+ },
+ "ContainerServiceVMSize": {
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContainerServiceVMSizeTypes",
+ "modelAsString": true
+ },
+ "description": "Size of agent VMs. Note: This is no longer maintained.",
+ "enum": [
+ "Standard_A1",
+ "Standard_A10",
+ "Standard_A11",
+ "Standard_A1_v2",
+ "Standard_A2",
+ "Standard_A2_v2",
+ "Standard_A2m_v2",
+ "Standard_A3",
+ "Standard_A4",
+ "Standard_A4_v2",
+ "Standard_A4m_v2",
+ "Standard_A5",
+ "Standard_A6",
+ "Standard_A7",
+ "Standard_A8",
+ "Standard_A8_v2",
+ "Standard_A8m_v2",
+ "Standard_A9",
+ "Standard_B2ms",
+ "Standard_B2s",
+ "Standard_B4ms",
+ "Standard_B8ms",
+ "Standard_D1",
+ "Standard_D11",
+ "Standard_D11_v2",
+ "Standard_D11_v2_Promo",
+ "Standard_D12",
+ "Standard_D12_v2",
+ "Standard_D12_v2_Promo",
+ "Standard_D13",
+ "Standard_D13_v2",
+ "Standard_D13_v2_Promo",
+ "Standard_D14",
+ "Standard_D14_v2",
+ "Standard_D14_v2_Promo",
+ "Standard_D15_v2",
+ "Standard_D16_v3",
+ "Standard_D16s_v3",
+ "Standard_D1_v2",
+ "Standard_D2",
+ "Standard_D2_v2",
+ "Standard_D2_v2_Promo",
+ "Standard_D2_v3",
+ "Standard_D2s_v3",
+ "Standard_D3",
+ "Standard_D32_v3",
+ "Standard_D32s_v3",
+ "Standard_D3_v2",
+ "Standard_D3_v2_Promo",
+ "Standard_D4",
+ "Standard_D4_v2",
+ "Standard_D4_v2_Promo",
+ "Standard_D4_v3",
+ "Standard_D4s_v3",
+ "Standard_D5_v2",
+ "Standard_D5_v2_Promo",
+ "Standard_D64_v3",
+ "Standard_D64s_v3",
+ "Standard_D8_v3",
+ "Standard_D8s_v3",
+ "Standard_DS1",
+ "Standard_DS11",
+ "Standard_DS11_v2",
+ "Standard_DS11_v2_Promo",
+ "Standard_DS12",
+ "Standard_DS12_v2",
+ "Standard_DS12_v2_Promo",
+ "Standard_DS13",
+ "Standard_DS13-2_v2",
+ "Standard_DS13-4_v2",
+ "Standard_DS13_v2",
+ "Standard_DS13_v2_Promo",
+ "Standard_DS14",
+ "Standard_DS14-4_v2",
+ "Standard_DS14-8_v2",
+ "Standard_DS14_v2",
+ "Standard_DS14_v2_Promo",
+ "Standard_DS15_v2",
+ "Standard_DS1_v2",
+ "Standard_DS2",
+ "Standard_DS2_v2",
+ "Standard_DS2_v2_Promo",
+ "Standard_DS3",
+ "Standard_DS3_v2",
+ "Standard_DS3_v2_Promo",
+ "Standard_DS4",
+ "Standard_DS4_v2",
+ "Standard_DS4_v2_Promo",
+ "Standard_DS5_v2",
+ "Standard_DS5_v2_Promo",
+ "Standard_E16_v3",
+ "Standard_E16s_v3",
+ "Standard_E2_v3",
+ "Standard_E2s_v3",
+ "Standard_E32-16s_v3",
+ "Standard_E32-8s_v3",
+ "Standard_E32_v3",
+ "Standard_E32s_v3",
+ "Standard_E4_v3",
+ "Standard_E4s_v3",
+ "Standard_E64-16s_v3",
+ "Standard_E64-32s_v3",
+ "Standard_E64_v3",
+ "Standard_E64s_v3",
+ "Standard_E8_v3",
+ "Standard_E8s_v3",
+ "Standard_F1",
+ "Standard_F16",
+ "Standard_F16s",
+ "Standard_F16s_v2",
+ "Standard_F1s",
+ "Standard_F2",
+ "Standard_F2s",
+ "Standard_F2s_v2",
+ "Standard_F32s_v2",
+ "Standard_F4",
+ "Standard_F4s",
+ "Standard_F4s_v2",
+ "Standard_F64s_v2",
+ "Standard_F72s_v2",
+ "Standard_F8",
+ "Standard_F8s",
+ "Standard_F8s_v2",
+ "Standard_G1",
+ "Standard_G2",
+ "Standard_G3",
+ "Standard_G4",
+ "Standard_G5",
+ "Standard_GS1",
+ "Standard_GS2",
+ "Standard_GS3",
+ "Standard_GS4",
+ "Standard_GS4-4",
+ "Standard_GS4-8",
+ "Standard_GS5",
+ "Standard_GS5-16",
+ "Standard_GS5-8",
+ "Standard_H16",
+ "Standard_H16m",
+ "Standard_H16mr",
+ "Standard_H16r",
+ "Standard_H8",
+ "Standard_H8m",
+ "Standard_L16s",
+ "Standard_L32s",
+ "Standard_L4s",
+ "Standard_L8s",
+ "Standard_M128-32ms",
+ "Standard_M128-64ms",
+ "Standard_M128ms",
+ "Standard_M128s",
+ "Standard_M64-16ms",
+ "Standard_M64-32ms",
+ "Standard_M64ms",
+ "Standard_M64s",
+ "Standard_NC12",
+ "Standard_NC12s_v2",
+ "Standard_NC12s_v3",
+ "Standard_NC24",
+ "Standard_NC24r",
+ "Standard_NC24rs_v2",
+ "Standard_NC24rs_v3",
+ "Standard_NC24s_v2",
+ "Standard_NC24s_v3",
+ "Standard_NC6",
+ "Standard_NC6s_v2",
+ "Standard_NC6s_v3",
+ "Standard_ND12s",
+ "Standard_ND24rs",
+ "Standard_ND24s",
+ "Standard_ND6s",
+ "Standard_NV12",
+ "Standard_NV24",
+ "Standard_NV6"
+ ]
+ },
+ "ManagedClusterServicePrincipalProfile": {
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "type": "string",
+ "description": "The ID for the service principal."
+ },
+ "secret": {
+ "type": "string",
+ "description": "The secret password associated with the service principal in plain text."
+ }
+ },
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.",
+ "required": [
+ "clientId"
+ ]
+ },
+ "ContainerServiceMasterProfile": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "enum": [
+ 1,
+ 3,
+ 5
+ ],
+ "x-ms-enum": {
+ "name": "Count",
+ "modelAsString": false
+ },
+ "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.",
+ "default": 1
+ },
+ "dnsPrefix": {
+ "type": "string",
+ "description": "DNS prefix to be used to create the FQDN for the master pool."
+ },
+ "vmSize": {
+ "$ref": "#/definitions/ContainerServiceVMSize",
+ "description": "Size of agent VMs."
+ },
+ "osDiskSizeGB": {
+ "$ref": "#/definitions/ContainerServiceOSDisk",
+ "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified."
+ },
+ "vnetSubnetID": {
+ "$ref": "#/definitions/ContainerServiceVnetSubnetID",
+ "description": "VNet SubnetID specifies the VNet's subnet identifier."
+ },
+ "firstConsecutiveStaticIP": {
+ "type": "string",
+ "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.",
+ "default": "10.240.255.5"
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/ContainerServiceStorageProfile",
+ "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice."
+ },
+ "fqdn": {
+ "readOnly": true,
+ "type": "string",
+ "description": "FQDN for the master pool."
+ }
+ },
+ "required": [
+ "dnsPrefix",
+ "vmSize"
+ ],
+ "description": "Profile for the container service master."
+ },
+ "ManagedClusterAgentPoolProfileProperties": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1."
+ },
+ "vmSize": {
+ "type": "string",
+ "title": "The size of the agent pool VMs.",
+ "description": "VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions"
+ },
+ "osDiskSizeGB": {
+ "$ref": "#/definitions/ContainerServiceOSDisk"
+ },
+ "osDiskType": {
+ "$ref": "#/definitions/OSDiskType"
+ },
+ "kubeletDiskType": {
+ "$ref": "#/definitions/KubeletDiskType"
+ },
+ "workloadRuntime": {
+ "$ref": "#/definitions/WorkloadRuntime"
+ },
+ "messageOfTheDay": {
+ "type": "string",
+ "title": "Message of the day for Linux nodes, base64-encoded.",
+ "description": "A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)."
+ },
+ "vnetSubnetID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/virtualNetworks/subnets"
+ }
+ ]
+ },
+ "title": "The ID of the subnet which agent pool nodes and optionally pods will join on startup.",
+ "description": "If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "podSubnetID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/virtualNetworks/subnets"
+ }
+ ]
+ },
+ "title": "The ID of the subnet which pods will join when launched.",
+ "description": "If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}"
+ },
+ "maxPods": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of pods that can run on a node."
+ },
+ "osType": {
+ "$ref": "#/definitions/OSType"
+ },
+ "osSKU": {
+ "$ref": "#/definitions/OSSKU"
+ },
+ "maxCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of nodes for auto-scaling"
+ },
+ "minCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The minimum number of nodes for auto-scaling"
+ },
+ "enableAutoScaling": {
+ "type": "boolean",
+ "description": "Whether to enable auto-scaler"
+ },
+ "scaleDownMode": {
+ "$ref": "#/definitions/ScaleDownMode",
+ "title": "The scale down mode to use when scaling the Agent Pool.",
+ "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+ },
+ "type": {
+ "$ref": "#/definitions/AgentPoolType"
+ },
+ "mode": {
+ "$ref": "#/definitions/AgentPoolMode"
+ },
+ "orchestratorVersion": {
+ "type": "string",
+ "title": "The version of Kubernetes specified by the user.",
+ "description": "Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "readOnly": true,
+ "type": "string",
+ "title": "The version of Kubernetes running on the Agent Pool.",
+ "description": "If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "$ref": "#/definitions/AgentPoolUpgradeSettings",
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "title": "Whether the Agent Pool is running or stopped.",
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded",
+ "$ref": "#/definitions/PowerState"
+ },
+ "availabilityZones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": "boolean",
+ "title": "Whether each node is allocated its own public IP.",
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "enableCustomCATrust": {
+ "type": "boolean",
+ "title": "Whether to enable Custom CA Trust feature.",
+ "description": "When set to true, AKS adds a label to the node indicating that the feature is enabled and deploys a daemonset along with host services to sync custom certificate authorities from user-provided list of base64 encoded certificates into node trust stores. Defaults to false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/publicIPPrefixes"
+ }
+ ]
+ },
+ "title": "The public IP prefix ID which VM nodes should use IPs from.",
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "$ref": "#/definitions/ScaleSetPriority",
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "$ref": "#/definitions/ScaleSetEvictionPolicy",
+ "title": "The Virtual Machine Scale Set eviction policy to use.",
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "$ref": "#/definitions/SpotMaxPrice",
+ "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "$ref": "#/definitions/ProximityPlacementGroupID",
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "$ref": "#/definitions/KubeletConfig",
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "$ref": "#/definitions/LinuxOSConfig",
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": "boolean",
+ "title": "Whether to enable host based OS and data drive encryption.",
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": "boolean",
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": "boolean",
+ "title": "Whether to use a FIPS-enabled OS.",
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "$ref": "#/definitions/GPUInstanceProfile",
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "capacityReservationGroupID": {
+ "$ref": "#/definitions/CapacityReservationGroupID",
+ "description": "AKS will associate the specified agent pool with the Capacity Reservation Group."
+ },
+ "hostGroupID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/hostGroups"
+ }
+ ]
+ },
+ "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.",
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ },
+ "windowsProfile": {
+ "$ref": "#/definitions/AgentPoolWindowsProfile",
+ "description": "The Windows agent pool's specific profile."
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/AgentPoolNetworkProfile",
+ "description": "Network-related settings of an agent pool."
+ }
+ },
+ "description": "Properties for the container service agent pool profile."
+ },
+ "AgentPoolNetworkProfile": {
+ "type": "object",
+ "properties": {
+ "nodePublicIPTags": {
+ "$ref": "#/definitions/NodePublicIPTags",
+ "description": "IPTags of instance-level public IPs."
+ },
+ "allowedHostPorts": {
+ "type": "array",
+ "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.",
+ "items": {
+ "$ref": "#/definitions/PortRange"
+ },
+ "x-ms-identifiers": []
+ },
+ "applicationSecurityGroups": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/applicationSecurityGroups"
+ }
+ ]
+ }
+ },
+ "description": "The IDs of the application security groups which agent pool will associate when created."
+ }
+ },
+ "description": "Network settings of an agent pool."
+ },
+ "NodePublicIPTags": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IPTag"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of tags associated with the node public IP address."
+ },
+ "IPTag": {
+ "type": "object",
+ "properties": {
+ "ipTagType": {
+ "type": "string",
+ "description": "The IP tag type. Example: RoutingPreference."
+ },
+ "tag": {
+ "type": "string",
+ "description": "The value of the IP tag associated with the public IP. Example: Internet."
+ }
+ },
+ "description": "Contains the IPTag associated with the object."
+ },
+ "PortRange": {
+ "type": "object",
+ "description": "The port range.",
+ "properties": {
+ "portStart": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 65535,
+ "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd."
+ },
+ "portEnd": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 65535,
+ "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart."
+ },
+ "protocol": {
+ "type": "string",
+ "description": "The network protocol of the port.",
+ "enum": [
+ "TCP",
+ "UDP"
+ ],
+ "x-ms-enum": {
+ "name": "Protocol",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "TCP",
+ "description": "TCP protocol."
+ },
+ {
+ "value": "UDP",
+ "description": "UDP protocol."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "ManagedClusterAgentPoolProfile": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties"
+ }
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Unique name of the agent pool profile in the context of the subscription and resource group.",
+ "description": "Windows agent pool names must be 6 characters or less.",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Profile for the container service agent pool."
+ },
+ "AgentPoolType": {
+ "type": "string",
+ "enum": [
+ "VirtualMachineScaleSets",
+ "AvailabilitySet"
+ ],
+ "x-ms-enum": {
+ "name": "AgentPoolType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "VirtualMachineScaleSets",
+ "description": "Create an Agent Pool backed by a Virtual Machine Scale Set."
+ },
+ {
+ "value": "AvailabilitySet",
+ "description": "Use of this is strongly discouraged."
+ }
+ ]
+ },
+ "description": "The type of Agent Pool."
+ },
+ "AgentPoolMode": {
+ "type": "string",
+ "enum": [
+ "System",
+ "User"
+ ],
+ "x-ms-enum": {
+ "name": "AgentPoolMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "System",
+ "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory."
+ },
+ {
+ "value": "User",
+ "description": "User agent pools are primarily for hosting your application pods."
+ }
+ ]
+ },
+ "title": "The mode of an agent pool.",
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "AgentPoolListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AgentPool"
+ },
+ "description": "The list of agent pools."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of agent pool results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Agent Pools operation."
+ },
+ "AgentPoolUpgradeSettings": {
+ "type": "object",
+ "properties": {
+ "maxSurge": {
+ "type": "string",
+ "title": "The maximum number or percentage of nodes that are surged during upgrade.",
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
+ }
+ },
+ "description": "Settings for upgrading an agentpool"
+ },
+ "AgentPool": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SubResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Properties of an agent pool.",
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "Agent Pool."
+ },
+ "ManagedClusterWindowsProfile": {
+ "type": "object",
+ "properties": {
+ "adminUsername": {
+ "type": "string",
+ "description": "Specifies the name of the administrator account.
**Restriction:** Cannot end in \".\"
**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".
**Minimum-length:** 1 character
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": "string",
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": "string",
+ "enum": [
+ "None",
+ "Windows_Server"
+ ],
+ "x-ms-enum": {
+ "name": "licenseType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No additional licensing is applied."
+ },
+ {
+ "value": "Windows_Server",
+ "description": "Enables Azure Hybrid User Benefits for Windows VMs."
+ }
+ ]
+ },
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": "boolean",
+ "title": "Whether to enable CSI proxy.",
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "$ref": "#/definitions/WindowsGmsaProfile",
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ },
+ "required": [
+ "adminUsername"
+ ],
+ "description": "Profile for Windows VMs in the managed cluster."
+ },
+ "WindowsGmsaProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "title": "Whether to enable Windows gMSA.",
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": "string",
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": "string",
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ },
+ "description": "Windows gMSA Profile in the managed cluster."
+ },
+ "ContainerServiceLinuxProfile": {
+ "type": "object",
+ "properties": {
+ "adminUsername": {
+ "type": "string",
+ "description": "The administrator username to use for Linux VMs.",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ "ssh": {
+ "$ref": "#/definitions/ContainerServiceSshConfiguration",
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ },
+ "required": [
+ "adminUsername",
+ "ssh"
+ ],
+ "description": "Profile for Linux VMs in the container service cluster."
+ },
+ "ManagedClusterNodeResourceGroupProfile": {
+ "type": "object",
+ "properties": {
+ "restrictionLevel": {
+ "type": "string",
+ "enum": [
+ "Unrestricted",
+ "ReadOnly"
+ ],
+ "x-ms-enum": {
+ "name": "RestrictionLevel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Unrestricted",
+ "description": "All RBAC permissions are allowed on the managed node resource group"
+ },
+ {
+ "value": "ReadOnly",
+ "description": "Only */read RBAC permissions allowed on the managed node resource group"
+ }
+ ]
+ },
+ "description": "The restriction level applied to the cluster's node resource group"
+ }
+ },
+ "description": "Node resource group lockdown profile for a managed cluster."
+ },
+ "ContainerServiceNetworkProfile": {
+ "type": "object",
+ "properties": {
+ "networkPlugin": {
+ "$ref": "#/definitions/NetworkPlugin",
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPluginMode": {
+ "$ref": "#/definitions/NetworkPluginMode",
+ "description": "Network plugin mode used for building the Kubernetes network."
+ },
+ "networkPolicy": {
+ "$ref": "#/definitions/NetworkPolicy",
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "$ref": "#/definitions/NetworkMode",
+ "title": "The network mode Azure CNI is configured with.",
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "ebpfDataplane": {
+ "$ref": "#/definitions/EbpfDataplane",
+ "description": "The eBPF dataplane used for building the Kubernetes network."
+ },
+ "podCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "10.244.0.0/16",
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "10.0.0.0/16",
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": "string",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
+ "default": "10.0.0.10",
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "dockerBridgeCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "172.17.0.1/16",
+ "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range."
+ },
+ "outboundType": {
+ "type": "string",
+ "enum": [
+ "loadBalancer",
+ "userDefinedRouting",
+ "managedNATGateway",
+ "userAssignedNATGateway"
+ ],
+ "x-ms-enum": {
+ "name": "outboundType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "loadBalancer",
+ "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)."
+ },
+ {
+ "value": "userDefinedRouting",
+ "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)."
+ },
+ {
+ "value": "managedNATGateway",
+ "description": "The AKS-managed NAT gateway is used for egress."
+ },
+ {
+ "value": "userAssignedNATGateway",
+ "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration."
+ }
+ ]
+ },
+ "default": "loadBalancer",
+ "title": "The outbound (egress) routing method.",
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "$ref": "#/definitions/LoadBalancerSku",
+ "title": "The load balancer sku for the managed cluster.",
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "$ref": "#/definitions/ManagedClusterLoadBalancerProfile",
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "$ref": "#/definitions/ManagedClusterNATGatewayProfile",
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "podCidrs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The CIDR notation IP ranges from which to assign pod IPs.",
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The CIDR notation IP ranges from which to assign service cluster IPs.",
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "The IP version to use for cluster networking and IP assignment.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "ipFamily",
+ "modelAsString": true
+ }
+ },
+ "title": "The IP families used to specify IP versions available to the cluster.",
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ },
+ "kubeProxyConfig": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)."
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "IPTABLES",
+ "IPVS"
+ ],
+ "x-ms-enum": {
+ "name": "mode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "IPTABLES",
+ "description": "IPTables proxy mode"
+ },
+ {
+ "value": "IPVS",
+ "description": "IPVS proxy mode. Must be using Kubernetes version >= 1.22."
+ }
+ ]
+ },
+ "description": "Specify which proxy mode to use ('IPTABLES' or 'IPVS')"
+ },
+ "ipvsConfig": {
+ "type": "object",
+ "properties": {
+ "scheduler": {
+ "type": "string",
+ "enum": [
+ "RoundRobin",
+ "LeastConnection"
+ ],
+ "x-ms-enum": {
+ "name": "ipvsScheduler",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "RoundRobin",
+ "description": "Round Robin"
+ },
+ {
+ "value": "LeastConnection",
+ "description": "Least Connection"
+ }
+ ]
+ },
+ "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html."
+ },
+ "tcpTimeoutSeconds": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value."
+ },
+ "tcpFinTimeoutSeconds": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value."
+ },
+ "udpTimeoutSeconds": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value."
+ }
+ },
+ "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'."
+ }
+ },
+ "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'."
+ }
+ },
+ "description": "Profile of network configuration."
+ },
+ "MaintenanceConfigurationListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MaintenanceConfiguration"
+ },
+ "description": "The list of maintenance configurations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of maintenance configuration results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List maintenance configurations operation."
+ },
+ "MaintenanceConfiguration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SubResource"
+ }
+ ],
+ "properties": {
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData",
+ "readOnly": true,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "description": "Properties of a default maintenance configuration.",
+ "$ref": "#/definitions/MaintenanceConfigurationProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.",
+ "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance."
+ },
+ "MaintenanceConfigurationProperties": {
+ "type": "object",
+ "properties": {
+ "timeInWeek": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TimeInWeek"
+ },
+ "title": "Time slots during the week when planned maintenance is allowed to proceed.",
+ "x-ms-identifiers": [],
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TimeSpan"
+ },
+ "x-ms-identifiers": [],
+ "description": "Time slots on which upgrade is not allowed."
+ },
+ "maintenanceWindow": {
+ "type": "object",
+ "$ref": "#/definitions/MaintenanceWindow",
+ "description": "Maintenance window for the maintenance configuration."
+ }
+ },
+ "description": "Properties used to configure planned maintenance for a Managed Cluster."
+ },
+ "MaintenanceWindow": {
+ "type": "object",
+ "properties": {
+ "schedule": {
+ "$ref": "#/definitions/Schedule",
+ "description": "Recurrence schedule for the maintenance window."
+ },
+ "durationHours": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 4,
+ "maximum": 24,
+ "default": 24,
+ "description": "Length of maintenance window range from 4 to 24 hours."
+ },
+ "utcOffset": {
+ "type": "string",
+ "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$",
+ "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'."
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date",
+ "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away."
+ },
+ "startTime": {
+ "type": "string",
+ "pattern": "^\\d{2}:\\d{2}$",
+ "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'."
+ },
+ "notAllowedDates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DateSpan"
+ },
+ "x-ms-identifiers": [],
+ "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time."
+ }
+ },
+ "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.",
+ "required": [
+ "schedule",
+ "durationHours",
+ "startTime"
+ ]
+ },
+ "Schedule": {
+ "type": "object",
+ "properties": {
+ "daily": {
+ "$ref": "#/definitions/DailySchedule"
+ },
+ "weekly": {
+ "$ref": "#/definitions/WeeklySchedule"
+ },
+ "absoluteMonthly": {
+ "$ref": "#/definitions/AbsoluteMonthlySchedule"
+ },
+ "relativeMonthly": {
+ "$ref": "#/definitions/RelativeMonthlySchedule"
+ }
+ },
+ "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule."
+ },
+ "DailySchedule": {
+ "type": "object",
+ "properties": {
+ "intervalDays": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 7,
+ "description": "Specifies the number of days between each set of occurrences."
+ }
+ },
+ "description": "For schedules like: 'recur every day' or 'recur every 3 days'.",
+ "required": [
+ "intervalDays"
+ ]
+ },
+ "WeeklySchedule": {
+ "type": "object",
+ "properties": {
+ "intervalWeeks": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 4,
+ "description": "Specifies the number of weeks between each set of occurrences."
+ },
+ "dayOfWeek": {
+ "$ref": "#/definitions/WeekDay",
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ },
+ "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.",
+ "required": [
+ "intervalWeeks",
+ "dayOfWeek"
+ ]
+ },
+ "AbsoluteMonthlySchedule": {
+ "type": "object",
+ "properties": {
+ "intervalMonths": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 6,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "dayOfMonth": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 31,
+ "description": "The date of the month."
+ }
+ },
+ "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.",
+ "required": [
+ "intervalMonths",
+ "dayOfMonth"
+ ]
+ },
+ "RelativeMonthlySchedule": {
+ "type": "object",
+ "properties": {
+ "intervalMonths": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 6,
+ "description": "Specifies the number of months between each set of occurrences."
+ },
+ "weekIndex": {
+ "type": "string",
+ "enum": [
+ "First",
+ "Second",
+ "Third",
+ "Fourth",
+ "Last"
+ ],
+ "x-ms-enum": {
+ "name": "type",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "First",
+ "description": "First."
+ },
+ {
+ "value": "Second",
+ "description": "Second."
+ },
+ {
+ "value": "Third",
+ "description": "Third."
+ },
+ {
+ "value": "Fourth",
+ "description": "Fourth."
+ },
+ {
+ "value": "Last",
+ "description": "Last."
+ }
+ ]
+ },
+ "title": "The week index.",
+ "description": "Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs."
+ },
+ "dayOfWeek": {
+ "$ref": "#/definitions/WeekDay",
+ "description": "Specifies on which day of the week the maintenance occurs."
+ }
+ },
+ "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.",
+ "required": [
+ "intervalMonths",
+ "weekIndex",
+ "dayOfWeek"
+ ]
+ },
+ "DateSpan": {
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "string",
+ "format": "date",
+ "description": "The start date of the date span."
+ },
+ "end": {
+ "type": "string",
+ "format": "date",
+ "description": "The end date of the date span."
+ }
+ },
+ "title": "A date range.",
+ "description": "For example, between '2022-12-23' and '2023-01-05'.",
+ "required": [
+ "start",
+ "end"
+ ]
+ },
+ "TimeInWeek": {
+ "type": "object",
+ "properties": {
+ "day": {
+ "$ref": "#/definitions/WeekDay",
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HourInDay"
+ },
+ "title": "A list of hours in the day used to identify a time range.",
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ },
+ "description": "Time in a week."
+ },
+ "WeekDay": {
+ "type": "string",
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
+ "x-ms-enum": {
+ "name": "WeekDay",
+ "modelAsString": true
+ },
+ "description": "The weekday enum."
+ },
+ "HourInDay": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 23,
+ "minimum": 0,
+ "description": "Hour in a day."
+ },
+ "TimeSpan": {
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The end of a time span"
+ }
+ },
+ "title": "A time range.",
+ "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z."
+ },
+ "RunCommandRequest": {
+ "type": "object",
+ "properties": {
+ "command": {
+ "type": "string",
+ "description": "The command to run."
+ },
+ "context": {
+ "type": "string",
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": "string",
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ },
+ "description": "A run command request",
+ "required": [
+ "command"
+ ]
+ },
+ "RunCommandResult": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The command id.",
+ "readOnly": true
+ },
+ "properties": {
+ "description": "Properties of command result.",
+ "$ref": "#/definitions/CommandResultProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "run command result."
+ },
+ "CommandResultProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": "integer",
+ "format": "int32",
+ "readOnly": true,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": "string",
+ "readOnly": true,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ },
+ "description": "The results of a run command"
+ },
+ "ManagedClusterNATGatewayProfile": {
+ "type": "object",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile",
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 120,
+ "minimum": 4,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.",
+ "default": 4
+ }
+ },
+ "description": "Profile of the managed cluster NAT gateway."
+ },
+ "ManagedClusterManagedOutboundIPProfile": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 16,
+ "minimum": 1,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ",
+ "default": 1
+ }
+ },
+ "description": "Profile of the managed outbound IP resources of the managed cluster."
+ },
+ "ManagedClusterLoadBalancerProfile": {
+ "type": "object",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ",
+ "default": 1
+ },
+ "countIPv6": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 100,
+ "minimum": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ",
+ "default": 0
+ }
+ },
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": "object",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "A list of public IP prefix resources."
+ }
+ },
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": "object",
+ "properties": {
+ "publicIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "A list of public IP resources."
+ }
+ },
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 64000,
+ "minimum": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.",
+ "default": 0
+ },
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 120,
+ "minimum": 4,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.",
+ "default": 30
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": "boolean",
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ },
+ "backendPoolType": {
+ "type": "string",
+ "x-ms-enum": {
+ "name": "BackendPoolType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NodeIPConfiguration",
+ "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend."
+ },
+ {
+ "value": "NodeIP",
+ "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend."
+ }
+ ]
+ },
+ "enum": [
+ "NodeIPConfiguration",
+ "NodeIP"
+ ],
+ "description": "The type of the managed inbound Load Balancer BackendPool.",
+ "default": "NodeIPConfiguration"
+ }
+ },
+ "description": "Profile of the managed cluster load balancer."
+ },
+ "ResourceReference": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "arm-id",
+ "description": "The fully qualified Azure resource id."
+ }
+ },
+ "description": "A reference to an Azure resource."
+ },
+ "ContainerServiceSshConfiguration": {
+ "type": "object",
+ "properties": {
+ "publicKeys": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerServiceSshPublicKey"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ },
+ "description": "SSH configuration for Linux-based VMs running on Azure.",
+ "required": [
+ "publicKeys"
+ ]
+ },
+ "ContainerServiceSshPublicKey": {
+ "type": "object",
+ "properties": {
+ "keyData": {
+ "type": "string",
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ },
+ "required": [
+ "keyData"
+ ],
+ "description": "Contains information about SSH certificate public key data."
+ },
+ "ContainerServiceDiagnosticsProfile": {
+ "type": "object",
+ "properties": {
+ "vmDiagnostics": {
+ "$ref": "#/definitions/ContainerServiceVMDiagnostics",
+ "description": "Profile for diagnostics on the container service VMs."
+ }
+ },
+ "description": "Profile for diagnostics on the container service cluster.",
+ "required": [
+ "vmDiagnostics"
+ ]
+ },
+ "ContainerServiceVMDiagnostics": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the VM diagnostic agent is provisioned on the VM."
+ },
+ "storageUri": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URI of the storage account where diagnostics are stored."
+ }
+ },
+ "description": "Profile for diagnostics on the container service VMs.",
+ "required": [
+ "enabled"
+ ]
+ },
+ "ManagedClusterListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedCluster"
+ },
+ "description": "The list of managed clusters."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of managed cluster results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Managed Clusters operation."
+ },
+ "ManagedCluster": {
+ "type": "object",
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/ManagedClusterSKU",
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "$ref": "#/definitions/ManagedClusterIdentity",
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "description": "Properties of a managed cluster.",
+ "$ref": "#/definitions/ManagedClusterProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "Managed cluster."
+ },
+ "ManagedClusterProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "$ref": "#/definitions/PowerState",
+ "description": "The Power State of the cluster.",
+ "readOnly": true
+ },
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot."
+ },
+ "maxAgentPools": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": "string",
+ "title": "The version of Kubernetes the Managed Cluster is requested to run.",
+ "description": "When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of Kubernetes the Managed Cluster is running."
+ },
+ "dnsPrefix": {
+ "type": "string",
+ "title": "The DNS prefix of the Managed Cluster.",
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": "string",
+ "title": "The FQDN subdomain of the private cluster with custom private dns zone.",
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "readOnly": true,
+ "type": "string",
+ "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.",
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfile"
+ },
+ "x-ms-identifiers": [],
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "$ref": "#/definitions/ContainerServiceLinuxProfile",
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "$ref": "#/definitions/ManagedClusterWindowsProfile",
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "$ref": "#/definitions/ManagedClusterServicePrincipalProfile",
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/ManagedClusterAddonProfile"
+ },
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProfile",
+ "title": "The pod identity profile of the Managed Cluster.",
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile",
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": "string",
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "nodeResourceGroupProfile": {
+ "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile",
+ "description": "The node resource group configuration profile."
+ },
+ "enableRBAC": {
+ "type": "boolean",
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "enablePodSecurityPolicy": {
+ "type": "boolean",
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "enableNamespaceResources": {
+ "type": "boolean",
+ "title": "Enable namespace as Azure resource.",
+ "description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/ContainerServiceNetworkProfile",
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "$ref": "#/definitions/ManagedClusterAADProfile",
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile",
+ "description": "The auto upgrade configuration."
+ },
+ "autoScalerProfile": {
+ "type": "object",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": "string",
+ "title": "Detects similar node pools and balances the number of nodes between them.",
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "expander": {
+ "type": "string",
+ "enum": [
+ "least-waste",
+ "most-pods",
+ "priority",
+ "random"
+ ],
+ "x-ms-enum": {
+ "name": "expander",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "least-waste",
+ "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources."
+ },
+ {
+ "value": "most-pods",
+ "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once."
+ },
+ {
+ "value": "priority",
+ "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)."
+ },
+ {
+ "value": "random",
+ "description": "Used when you don't have a particular need for the node groups to scale differently."
+ }
+ ]
+ },
+ "title": "The expander to use when scaling up",
+ "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information."
+ },
+ "max-empty-bulk-delete": {
+ "type": "string",
+ "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.",
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": "string",
+ "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.",
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": "string",
+ "title": "The maximum time the autoscaler waits for a node to be provisioned.",
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": "string",
+ "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.",
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": "string",
+ "title": "Ignore unscheduled pods before they're a certain age.",
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": "string",
+ "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.",
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": "string",
+ "title": "How often cluster is reevaluated for scale up or down.",
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": "string",
+ "title": "How long after scale up that scale down evaluation resumes",
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": "string",
+ "title": "How long after node deletion that scale down evaluation resumes.",
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": "string",
+ "title": "How long after scale down failure that scale down evaluation resumes.",
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": "string",
+ "title": "How long a node should be unneeded before it is eligible for scale down.",
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": "string",
+ "title": "How long an unready node should be unneeded before it is eligible for scale down",
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": "string",
+ "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.",
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": "string",
+ "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.",
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": "string",
+ "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)",
+ "description": "The default is true."
+ }
+ },
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile",
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/diskEncryptionSets"
+ }
+ ]
+ },
+ "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.",
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserAssignedIdentity"
+ },
+ "description": "Identities associated with the cluster."
+ },
+ "privateLinkResources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ },
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": "boolean",
+ "title": "If local accounts should be disabled on the Managed Cluster.",
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "$ref": "#/definitions/ManagedClusterHTTPProxyConfig",
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfile",
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/ManagedClusterStorageProfile",
+ "description": "Storage profile for the managed cluster."
+ },
+ "ingressProfile": {
+ "$ref": "#/definitions/ManagedClusterIngressProfile",
+ "description": "Ingress profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled",
+ "SecuredByPerimeter"
+ ],
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Inbound/Outbound to the managedCluster is allowed."
+ },
+ {
+ "value": "Disabled",
+ "description": "Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed."
+ },
+ {
+ "value": "SecuredByPerimeter",
+ "description": "Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters."
+ }
+ ]
+ },
+ "title": "PublicNetworkAccess of the managedCluster",
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile"
+ },
+ "azureMonitorProfile": {
+ "$ref": "#/definitions/ManagedClusterAzureMonitorProfile"
+ },
+ "guardrailsProfile": {
+ "$ref": "#/definitions/GuardrailsProfile",
+ "description": "The guardrails profile holds all the guardrails information for a given cluster"
+ }
+ },
+ "description": "Properties of the managed cluster."
+ },
+ "PowerState": {
+ "type": "object",
+ "description": "Describes the Power State of the cluster",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Tells whether the cluster is Running or Stopped",
+ "enum": [
+ "Running",
+ "Stopped"
+ ],
+ "x-ms-enum": {
+ "name": "code",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Running",
+ "description": "The cluster is running."
+ },
+ {
+ "value": "Stopped",
+ "description": "The cluster is stopped."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "ManagedClusterAPIServerAccessProfile": {
+ "type": "object",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The IP ranges authorized to access the Kubernetes API server.",
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": "boolean",
+ "title": "Whether to create the cluster as a private cluster or not.",
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": "string",
+ "title": "The private DNS zone mode for the cluster.",
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": "boolean",
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": "boolean",
+ "description": "Whether to disable run command for the cluster or not."
+ },
+ "enableVnetIntegration": {
+ "type": "boolean",
+ "description": "Whether to enable apiserver vnet integration for the cluster or not."
+ },
+ "subnetId": {
+ "type": "string",
+ "title": "The subnet to be used when apiserver vnet integration is enabled.",
+ "description": "It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration."
+ }
+ },
+ "description": "Access profile for managed cluster API server."
+ },
+ "ManagedClusterIdentity": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": "string",
+ "title": "The type of identity used for the managed cluster.",
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "SystemAssigned",
+ "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources."
+ },
+ {
+ "value": "UserAssigned",
+ "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources."
+ },
+ {
+ "value": "None",
+ "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead."
+ }
+ ]
+ }
+ },
+ "userAssignedIdentities": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.",
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the managed cluster."
+ },
+ "UserAssignedIdentity": {
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
+ }
+ ]
+ },
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the user assigned identity."
+ }
+ },
+ "description": "Details about a user assigned identity."
+ },
+ "ManagedClusterAccessProfile": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AccessProfile of a managed cluster.",
+ "$ref": "#/definitions/AccessProfile",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "Managed cluster Access Profile.",
+ "x-ms-azure-resource": false
+ },
+ "AccessProfile": {
+ "type": "object",
+ "properties": {
+ "kubeConfig": {
+ "type": "string",
+ "format": "byte",
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "Profile for enabling a user to access a managed cluster."
+ },
+ "ManagedClusterPoolUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "name": {
+ "type": "string",
+ "description": "The Agent Pool name."
+ },
+ "osType": {
+ "$ref": "#/definitions/OSType"
+ },
+ "upgrades": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether the Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of orchestrator types and versions available for upgrade."
+ }
+ },
+ "required": [
+ "kubernetesVersion",
+ "osType"
+ ],
+ "description": "The list of available upgrade versions."
+ },
+ "ManagedClusterUpgradeProfileProperties": {
+ "type": "object",
+ "properties": {
+ "controlPlaneProfile": {
+ "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile",
+ "description": "The list of available upgrade versions for the control plane."
+ },
+ "agentPoolProfiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of available upgrade versions for agent pools."
+ }
+ },
+ "required": [
+ "controlPlaneProfile",
+ "agentPoolProfiles"
+ ],
+ "description": "Control plane and agent pool upgrade profiles."
+ },
+ "ManagedClusterAutoUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "upgradeChannel": {
+ "type": "string",
+ "enum": [
+ "rapid",
+ "stable",
+ "patch",
+ "node-image",
+ "none"
+ ],
+ "x-ms-enum": {
+ "name": "upgradeChannel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "rapid",
+ "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1."
+ },
+ {
+ "value": "stable",
+ "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6."
+ },
+ {
+ "value": "patch",
+ "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9."
+ },
+ {
+ "value": "node-image",
+ "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching"
+ },
+ {
+ "value": "none",
+ "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes."
+ }
+ ]
+ },
+ "title": "The upgrade channel for auto upgrade. The default is 'none'.",
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ },
+ "nodeOSUpgradeChannel": {
+ "type": "string",
+ "enum": [
+ "Unmanaged",
+ "None",
+ "SecurityPatch",
+ "NodeImage"
+ ],
+ "x-ms-enum": {
+ "name": "NodeOSUpgradeChannel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates"
+ },
+ {
+ "value": "Unmanaged",
+ "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially, and will be patched at some later time by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice"
+ },
+ {
+ "value": "SecurityPatch",
+ "description": "AKS will update the nodes VHD with patches from the image maintainer labelled \"security only\" on a regular basis. Where possible, patches will also be applied without reimaging to existing nodes. Some patches, such as kernel patches, cannot be applied to existing nodes without disruption. For such patches, the VHD will be updated, and machines will be rolling reimaged to that VHD following maintenance windows and surge settings. This option incurs the extra cost of hosting the VHDs in your node resource group."
+ },
+ {
+ "value": "NodeImage",
+ "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images."
+ }
+ ]
+ },
+ "title": "Manner in which the OS on your nodes is updated",
+ "description": "The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA."
+ }
+ },
+ "description": "Auto upgrade profile for a managed cluster."
+ },
+ "ManagedClusterAADProfile": {
+ "type": "object",
+ "properties": {
+ "managed": {
+ "type": "boolean",
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": "boolean",
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": "string",
+ "description": "The client AAD application ID."
+ },
+ "serverAppID": {
+ "type": "string",
+ "description": "The server AAD application ID."
+ },
+ "serverAppSecret": {
+ "type": "string",
+ "description": "The server AAD application secret."
+ },
+ "tenantID": {
+ "type": "string",
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ },
+ "title": "AADProfile specifies attributes for Azure Active Directory integration.",
+ "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)."
+ },
+ "ManagedClusterAddonProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "readOnly": true,
+ "description": "Information of user assigned identity used by this add-on.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UserAssignedIdentity"
+ }
+ ]
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "description": "A Kubernetes add-on profile for a managed cluster."
+ },
+ "ManagedClusterPodIdentity": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": "string",
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/UserAssignedIdentity",
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state of the pod identity.",
+ "enum": [
+ "Assigned",
+ "Canceled",
+ "Deleting",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterPodIdentityProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "provisioningInfo": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError",
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ }
+ },
+ "required": [
+ "name",
+ "namespace",
+ "identity"
+ ],
+ "description": "Details about the pod identity assigned to the Managed Cluster."
+ },
+ "ManagedClusterPodIdentityProvisioningError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody",
+ "description": "Details about the error."
+ }
+ },
+ "description": "An error response from the pod identity provisioning."
+ },
+ "ManagedClusterPodIdentityProvisioningErrorBody": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody"
+ },
+ "x-ms-identifiers": [],
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the pod identity provisioning."
+ },
+ "ManagedClusterPodIdentityException": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": "object",
+ "description": "The pod labels to match.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "namespace",
+ "podLabels"
+ ],
+ "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.",
+ "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details."
+ },
+ "ManagedClusterPodIdentityProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": "boolean",
+ "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.",
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "description": "The pod identities to use in the cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentity"
+ },
+ "x-ms-identifiers": []
+ },
+ "userAssignedIdentityExceptions": {
+ "description": "The pod identity exceptions to allow.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityException"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "title": "The pod identity profile of the Managed Cluster.",
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration."
+ },
+ "ManagedClusterOIDCIssuerProfile": {
+ "type": "object",
+ "properties": {
+ "issuerURL": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ },
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "ManagedClusterUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the upgrade profile."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the upgrade profile."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the upgrade profile."
+ },
+ "properties": {
+ "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties",
+ "description": "The properties of the upgrade profile.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available upgrades for compute pools."
+ },
+ "AgentPoolUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the agent pool upgrade profile."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the agent pool upgrade profile."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the agent pool upgrade profile."
+ },
+ "properties": {
+ "$ref": "#/definitions/AgentPoolUpgradeProfileProperties",
+ "description": "The properties of the agent pool upgrade profile.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available upgrades for an agent pool."
+ },
+ "AgentPoolUpgradeProfileProperties": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "osType": {
+ "$ref": "#/definitions/OSType"
+ },
+ "upgrades": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether the Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of orchestrator types and versions available for upgrade."
+ },
+ "latestNodeImageVersion": {
+ "type": "string",
+ "description": "The latest AKS supported node image version."
+ }
+ },
+ "required": [
+ "kubernetesVersion",
+ "osType"
+ ],
+ "description": "The list of available upgrade versions."
+ },
+ "AgentPoolAvailableVersions": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the agent pool version list."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the agent pool version list."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Type of the agent pool version list."
+ },
+ "properties": {
+ "$ref": "#/definitions/AgentPoolAvailableVersionsProperties",
+ "description": "Properties of agent pool available versions.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available versions for an agent pool."
+ },
+ "AgentPoolAvailableVersionsProperties": {
+ "type": "object",
+ "properties": {
+ "agentPoolVersions": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "default": {
+ "type": "boolean",
+ "description": "Whether this version is the default agent pool version."
+ },
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of versions available for agent pool."
+ }
+ },
+ "description": "The list of available agent pool versions."
+ },
+ "OSType": {
+ "type": "string",
+ "default": "Linux",
+ "enum": [
+ "Linux",
+ "Windows"
+ ],
+ "x-ms-enum": {
+ "name": "OSType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Linux",
+ "description": "Use Linux."
+ },
+ {
+ "value": "Windows",
+ "description": "Use Windows."
+ }
+ ]
+ },
+ "description": "The operating system type. The default is Linux."
+ },
+ "OSSKU": {
+ "type": "string",
+ "enum": [
+ "Ubuntu",
+ "CBLMariner",
+ "Mariner",
+ "Windows2019",
+ "Windows2022"
+ ],
+ "x-ms-enum": {
+ "name": "OSSKU",
+ "modelAsString": true
+ },
+ "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated."
+ },
+ "ScaleSetPriority": {
+ "type": "string",
+ "default": "Regular",
+ "enum": [
+ "Spot",
+ "Regular"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleSetPriority",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Spot",
+ "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information."
+ },
+ {
+ "value": "Regular",
+ "description": "Regular VMs will be used."
+ }
+ ]
+ },
+ "description": "The Virtual Machine Scale Set priority."
+ },
+ "ScaleSetEvictionPolicy": {
+ "type": "string",
+ "default": "Delete",
+ "enum": [
+ "Delete",
+ "Deallocate"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleSetEvictionPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Delete",
+ "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted."
+ },
+ {
+ "value": "Deallocate",
+ "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading."
+ }
+ ]
+ },
+ "title": "The Virtual Machine Scale Set eviction policy.",
+ "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)"
+ },
+ "SpotMaxPrice": {
+ "type": "number",
+ "default": -1,
+ "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "ScaleDownMode": {
+ "type": "string",
+ "enum": [
+ "Delete",
+ "Deallocate"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleDownMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Delete",
+ "description": "Create new instances during scale up and remove instances during scale down."
+ },
+ {
+ "value": "Deallocate",
+ "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down."
+ }
+ ]
+ },
+ "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)."
+ },
+ "ProximityPlacementGroupID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/proximityPlacementGroups"
+ }
+ ]
+ },
+ "description": "The ID for Proximity Placement Group."
+ },
+ "CredentialResults": {
+ "type": "object",
+ "properties": {
+ "kubeconfigs": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/CredentialResult"
+ },
+ "x-ms-identifiers": [],
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "The list credential result response."
+ },
+ "CredentialResult": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": "string",
+ "format": "byte",
+ "readOnly": true,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "The credential result response."
+ },
+ "CloudError": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody",
+ "description": "Details about the error."
+ }
+ },
+ "description": "An error response from the Container service."
+ },
+ "CloudErrorBody": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "x-ms-identifiers": [],
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the Container service."
+ },
+ "ManagedClusterSKU": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of a managed cluster SKU.",
+ "enum": [
+ "Basic"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterSKUName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "type": "string",
+ "title": "The tier of a managed cluster SKU.",
+ "description": "If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details.",
+ "enum": [
+ "Paid",
+ "Free"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterSKUTier",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Paid",
+ "description": "Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones."
+ },
+ {
+ "value": "Free",
+ "description": "No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%."
+ }
+ ]
+ }
+ }
+ },
+ "description": "The SKU of a Managed Cluster."
+ },
+ "PrivateEndpointConnectionListResult": {
+ "type": "object",
+ "description": "A list of private endpoint connections",
+ "properties": {
+ "value": {
+ "description": "The collection value.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "A private endpoint connection",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the private endpoint connection."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection.",
+ "externalDocs": {
+ "url": "https://aka.ms/search-naming-rules"
+ }
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource type."
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties of a private endpoint connection.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "PrivateEndpointConnectionProperties": {
+ "type": "object",
+ "description": "Properties of a private endpoint connection.",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Canceled",
+ "Creating",
+ "Deleting",
+ "Failed",
+ "Succeeded"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ },
+ "required": [
+ "privateLinkServiceConnectionState"
+ ]
+ },
+ "PrivateEndpoint": {
+ "type": "object",
+ "description": "Private endpoint which a connection belongs to.",
+ "properties": {
+ "id": {
+ "description": "The resource ID of the private endpoint",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionState": {
+ "description": "The state of a private link service connection.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "description": "The private link service connection status.",
+ "x-ms-enum": {
+ "name": "ConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "type": "string",
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ "PrivateLinkResourcesListResult": {
+ "type": "object",
+ "description": "A list of private link resources",
+ "properties": {
+ "value": {
+ "description": "The collection value.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A private link resource",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the private link resource.",
+ "externalDocs": {
+ "url": "https://aka.ms/search-naming-rules"
+ }
+ },
+ "type": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": "string",
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "readOnly": true,
+ "type": "string",
+ "format": "arm-id",
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ "OSDiskType": {
+ "type": "string",
+ "enum": [
+ "Managed",
+ "Ephemeral"
+ ],
+ "x-ms-enum": {
+ "name": "OSDiskType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Managed",
+ "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency."
+ },
+ {
+ "value": "Ephemeral",
+ "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades."
+ }
+ ]
+ },
+ "title": "The OS disk type to be used for machines in the agent pool.",
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "KubeletDiskType": {
+ "type": "string",
+ "enum": [
+ "OS",
+ "Temporary"
+ ],
+ "x-ms-enum": {
+ "name": "KubeletDiskType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "OS",
+ "description": "Kubelet will use the OS disk for its data."
+ },
+ {
+ "value": "Temporary",
+ "description": "Kubelet will use the temporary disk for its data."
+ }
+ ]
+ },
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "WorkloadRuntime": {
+ "type": "string",
+ "enum": [
+ "OCIContainer",
+ "WasmWasi",
+ "KataMshvVmIsolation"
+ ],
+ "x-ms-enum": {
+ "name": "WorkloadRuntime",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "OCIContainer",
+ "description": "Nodes will use Kubelet to run standard OCI container workloads."
+ },
+ {
+ "value": "WasmWasi",
+ "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)."
+ },
+ {
+ "value": "KataMshvVmIsolation",
+ "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series."
+ }
+ ]
+ },
+ "description": "Determines the type of workload a node can run."
+ },
+ "KubeletConfig": {
+ "title": "Kubelet configurations of agent nodes.",
+ "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.",
+ "type": "object",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": "string",
+ "title": "The CPU Manager policy to use.",
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": "boolean",
+ "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.",
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": "string",
+ "title": "The CPU CFS quota period value.",
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The percent of disk usage after which image garbage collection is always run.",
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The percent of disk usage before which image garbage collection is never run.",
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": "string",
+ "title": "The Topology Manager policy to use.",
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": "boolean",
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.",
+ "minimum": 2
+ },
+ "podMaxPids": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of processes per pod."
+ }
+ }
+ },
+ "LinuxOSConfig": {
+ "title": "OS configurations of Linux agent nodes.",
+ "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.",
+ "type": "object",
+ "properties": {
+ "sysctls": {
+ "$ref": "#/definitions/SysctlConfig",
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": "string",
+ "title": "Whether transparent hugepages are enabled.",
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": "string",
+ "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.",
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ "AgentPoolWindowsProfile": {
+ "type": "object",
+ "description": "The Windows agent pool's specific profile.",
+ "properties": {
+ "disableOutboundNat": {
+ "type": "boolean",
+ "title": "Whether to disable OutboundNAT in windows nodes",
+ "description": "The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled."
+ }
+ }
+ },
+ "SysctlConfig": {
+ "description": "Sysctl settings for Linux agent nodes.",
+ "type": "object",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": "boolean",
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": "string",
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ "ManagedClusterHTTPProxyConfig": {
+ "description": "Cluster HTTP proxy configuration.",
+ "type": "object",
+ "properties": {
+ "httpProxy": {
+ "type": "string",
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": "string",
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The endpoints that should not go through proxy."
+ },
+ "effectiveNoProxy": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS."
+ },
+ "trustedCa": {
+ "type": "string",
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ "GPUInstanceProfile": {
+ "type": "string",
+ "enum": [
+ "MIG1g",
+ "MIG2g",
+ "MIG3g",
+ "MIG4g",
+ "MIG7g"
+ ],
+ "x-ms-enum": {
+ "name": "GPUInstanceProfile ",
+ "modelAsString": true
+ },
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "ExtendedLocationType": {
+ "type": "string",
+ "description": "The type of extendedLocation.",
+ "enum": [
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "ExtendedLocationTypes",
+ "modelAsString": true
+ }
+ },
+ "ExtendedLocation": {
+ "type": "object",
+ "description": "The complex type of the extended location.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "$ref": "#/definitions/ExtendedLocationType",
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ "OSOptionProperty": {
+ "type": "object",
+ "properties": {
+ "os-type": {
+ "type": "string",
+ "description": "The OS type."
+ },
+ "enable-fips-image": {
+ "type": "boolean",
+ "description": "Whether the image is FIPS-enabled."
+ }
+ },
+ "required": [
+ "os-type",
+ "enable-fips-image"
+ ],
+ "description": "OS option property."
+ },
+ "OSOptionPropertyList": {
+ "type": "object",
+ "properties": {
+ "osOptionPropertyList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OSOptionProperty"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of OS options."
+ }
+ },
+ "required": [
+ "osOptionPropertyList"
+ ],
+ "description": "The list of OS option properties."
+ },
+ "OSOptionProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the OS option resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the OS option resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the OS option resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/OSOptionPropertyList",
+ "description": "The list of OS options.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The OS option profile."
+ },
+ "EndpointDependency": {
+ "description": "A domain name that AKS agent nodes are reaching at.",
+ "type": "object",
+ "properties": {
+ "domainName": {
+ "description": "The domain name of the dependency.",
+ "type": "string"
+ },
+ "endpointDetails": {
+ "description": "The Ports and Protocols used when connecting to domainName.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDetail"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "EndpointDetail": {
+ "description": "connect information from the AKS agent nodes to a single endpoint.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "An IP Address that Domain Name currently resolves to.",
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port an endpoint is connected to.",
+ "type": "integer"
+ },
+ "protocol": {
+ "description": "The protocol used for connection",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the detail",
+ "type": "string"
+ }
+ }
+ },
+ "OutboundEnvironmentEndpoint": {
+ "description": "Egress endpoints which AKS agent nodes connect to for common purpose.",
+ "type": "object",
+ "properties": {
+ "category": {
+ "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "The endpoints that AKS agent nodes connect to",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDependency"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "OutboundEnvironmentEndpointCollection": {
+ "description": "Collection of OutboundEnvironmentEndpoint",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpoint"
+ },
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedClusterSecurityProfile": {
+ "type": "object",
+ "properties": {
+ "defender": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileDefender",
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "$ref": "#/definitions/AzureKeyVaultKms",
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ },
+ "workloadIdentity": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity",
+ "description": "[Workload Identity](https://azure.github.io/azure-workload-identity/docs/) settings for the security profile."
+ },
+ "imageCleaner": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner",
+ "description": "ImageCleaner settings for the security profile."
+ },
+ "nodeRestriction": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileNodeRestriction",
+ "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile."
+ },
+ "customCATrustCertificates": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileCustomCATrustCertificates",
+ "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on nodes with the Custom CA Trust feature enabled. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)"
+ }
+ },
+ "description": "Security profile for the container service cluster."
+ },
+ "ManagedClusterSecurityProfileDefender": {
+ "type": "object",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.OperationalInsights/workspaces"
+ }
+ ]
+ },
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ }
+ },
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "ManagedClusterSecurityProfileDefenderSecurityMonitoring": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Defender threat detection"
+ }
+ },
+ "description": "Microsoft Defender settings for the security profile threat detection."
+ },
+ "ManagedClusterStorageProfile": {
+ "type": "object",
+ "properties": {
+ "diskCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver",
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver",
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController",
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver",
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ },
+ "description": "Storage profile for the container service cluster."
+ },
+ "AzureKeyVaultKms": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": "string",
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": "string",
+ "enum": [
+ "Public",
+ "Private"
+ ],
+ "default": "Public",
+ "x-ms-enum": {
+ "name": "KeyVaultNetworkAccessTypes",
+ "modelAsString": true
+ },
+ "title": "Network access of the key vault",
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": "string",
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ },
+ "description": "Azure Key Vault key management service settings for the security profile."
+ },
+ "ManagedClusterIngressProfile": {
+ "type": "object",
+ "properties": {
+ "webAppRouting": {
+ "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting",
+ "description": "Web App Routing settings for the ingress profile."
+ }
+ },
+ "description": "Ingress profile for the container service cluster."
+ },
+ "ManagedClusterIngressProfileWebAppRouting": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Web App Routing."
+ },
+ "dnsZoneResourceId": {
+ "type": "string",
+ "description": "Resource ID of the DNS Zone to be associated with the web app. Used only when Web App Routing is enabled."
+ }
+ },
+ "description": "Web App Routing settings for the ingress profile."
+ },
+ "ManagedClusterSecurityProfileWorkloadIdentity": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Workload Identity"
+ }
+ },
+ "description": "Workload Identity settings for the security profile."
+ },
+ "ManagedClusterSecurityProfileImageCleaner": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable ImageCleaner on AKS cluster."
+ },
+ "intervalHours": {
+ "type": "integer",
+ "format": "int32",
+ "description": "ImageCleaner scanning interval."
+ }
+ },
+ "description": "ImageCleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile."
+ },
+ "ManagedClusterSecurityProfileNodeRestriction": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Node Restriction"
+ }
+ },
+ "description": "Node Restriction settings for the security profile."
+ },
+ "ManagedClusterSecurityProfileCustomCATrustCertificates": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "byte"
+ },
+ "minItems": 0,
+ "maxItems": 10,
+ "title": "The list of base64 encoded certificate strings that will be added to the node trust store. At most 10 strings can be provided.",
+ "description": "Certificates will only be added to trust stores on node pools that have enableCustomCATrust field set to true. If updated, the new list of certificates will be installed in the trust store in place of the old certificates. The certificates are applied asynchronously and will be available a short time after the list is updated."
+ },
+ "ManagedClusterStorageProfileDiskCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ },
+ "version": {
+ "type": "string",
+ "description": "The version of AzureDisk CSI Driver. The default value is v1."
+ }
+ },
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileFileCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ },
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileSnapshotController": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ },
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileBlobCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ },
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ },
+ "CreationData": {
+ "description": "Data used when creating a target resource from a source resource.",
+ "type": "object",
+ "properties": {
+ "sourceResourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ "SnapshotListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Snapshot"
+ },
+ "description": "The list of snapshots."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of snapshot results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Snapshots operation."
+ },
+ "ManagedClusterSnapshotListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterSnapshot"
+ },
+ "description": "The list of managed cluster snapshots."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of managed cluster snapshot results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Managed Cluster Snapshots operation."
+ },
+ "Snapshot": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Properties of a snapshot.",
+ "$ref": "#/definitions/SnapshotProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "A node pool snapshot resource."
+ },
+ "ManagedClusterSnapshot": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Properties of a managed cluster snapshot.",
+ "$ref": "#/definitions/ManagedClusterSnapshotProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "A managed cluster snapshot resource."
+ },
+ "SnapshotProperties": {
+ "type": "object",
+ "properties": {
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "$ref": "#/definitions/SnapshotType"
+ },
+ "kubernetesVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of node image."
+ },
+ "osType": {
+ "readOnly": true,
+ "$ref": "#/definitions/OSType"
+ },
+ "osSku": {
+ "readOnly": true,
+ "$ref": "#/definitions/OSSKU"
+ },
+ "vmSize": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "readOnly": true,
+ "type": "boolean",
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ },
+ "description": "Properties used to configure a node pool snapshot."
+ },
+ "ManagedClusterSnapshotProperties": {
+ "type": "object",
+ "properties": {
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "$ref": "#/definitions/SnapshotType"
+ },
+ "managedClusterPropertiesReadOnly": {
+ "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot",
+ "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only."
+ }
+ },
+ "description": "Properties for a managed cluster snapshot."
+ },
+ "ManagedClusterPropertiesForSnapshot": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The current kubernetes version."
+ },
+ "sku": {
+ "type": "object",
+ "$ref": "#/definitions/ManagedClusterSKU",
+ "description": "The current managed cluster sku."
+ },
+ "enableRbac": {
+ "type": "boolean",
+ "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not."
+ },
+ "networkProfile": {
+ "type": "object",
+ "$ref": "#/definitions/NetworkProfileForSnapshot",
+ "description": "The current network profile."
+ }
+ },
+ "description": "managed cluster properties for snapshot, these properties are read only."
+ },
+ "NetworkProfileForSnapshot": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "networkPlugin": {
+ "$ref": "#/definitions/NetworkPlugin",
+ "description": "networkPlugin for managed cluster snapshot."
+ },
+ "networkPluginMode": {
+ "$ref": "#/definitions/NetworkPluginMode",
+ "description": "NetworkPluginMode for managed cluster snapshot."
+ },
+ "networkPolicy": {
+ "$ref": "#/definitions/NetworkPolicy",
+ "description": "networkPolicy for managed cluster snapshot."
+ },
+ "networkMode": {
+ "$ref": "#/definitions/NetworkMode",
+ "description": "networkMode for managed cluster snapshot."
+ },
+ "loadBalancerSku": {
+ "$ref": "#/definitions/LoadBalancerSku",
+ "description": "loadBalancerSku for managed cluster snapshot."
+ }
+ },
+ "description": "network profile for managed cluster snapshot, these properties are read only."
+ },
+ "NetworkPlugin": {
+ "type": "string",
+ "enum": [
+ "azure",
+ "kubenet",
+ "none"
+ ],
+ "default": "kubenet",
+ "x-ms-enum": {
+ "name": "NetworkPlugin",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "azure",
+ "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information."
+ },
+ {
+ "value": "kubenet",
+ "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information."
+ },
+ {
+ "value": "none",
+ "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality."
+ }
+ ]
+ },
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "NetworkPluginMode": {
+ "type": "string",
+ "enum": [
+ "Overlay"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkPluginMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Overlay",
+ "description": "Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge."
+ }
+ ]
+ },
+ "description": "The mode the network plugin should use."
+ },
+ "NetworkPolicy": {
+ "type": "string",
+ "enum": [
+ "calico",
+ "azure"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "calico",
+ "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information."
+ },
+ {
+ "value": "azure",
+ "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information."
+ }
+ ]
+ },
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "NetworkMode": {
+ "type": "string",
+ "enum": [
+ "transparent",
+ "bridge"
+ ],
+ "x-ms-enum": {
+ "name": "networkMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "transparent",
+ "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information."
+ },
+ {
+ "value": "bridge",
+ "description": "This is no longer supported"
+ }
+ ]
+ },
+ "title": "The network mode Azure CNI is configured with.",
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "EbpfDataplane": {
+ "type": "string",
+ "enum": [
+ "cilium"
+ ],
+ "x-ms-enum": {
+ "name": "ebpfDataplane",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "cilium",
+ "description": "Use Cilium for networking in the Kubernetes cluster."
+ }
+ ]
+ },
+ "description": "The eBPF dataplane used for building the Kubernetes network."
+ },
+ "LoadBalancerSku": {
+ "type": "string",
+ "enum": [
+ "standard",
+ "basic"
+ ],
+ "x-ms-enum": {
+ "name": "loadBalancerSku",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "standard",
+ "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article."
+ },
+ {
+ "value": "basic",
+ "description": "Use a basic Load Balancer with limited functionality."
+ }
+ ]
+ },
+ "title": "The load balancer sku for the managed cluster.",
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "SnapshotType": {
+ "type": "string",
+ "default": "NodePool",
+ "enum": [
+ "NodePool",
+ "ManagedCluster"
+ ],
+ "x-ms-enum": {
+ "name": "SnapshotType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NodePool",
+ "description": "The snapshot is a snapshot of a node pool."
+ },
+ {
+ "value": "ManagedCluster",
+ "description": "The snapshot is a snapshot of a managed cluster."
+ }
+ ]
+ },
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "CapacityReservationGroupID": {
+ "description": "Capacity Reservation Group ID for AgentPool to associate",
+ "type": "string"
+ },
+ "TrustedAccessRoleRule": {
+ "type": "object",
+ "description": "Rule for trusted access role",
+ "properties": {
+ "verbs": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "List of allowed verbs"
+ },
+ "apiGroups": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "List of allowed apiGroups"
+ },
+ "resources": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "List of allowed resources"
+ },
+ "resourceNames": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "List of allowed names"
+ },
+ "nonResourceURLs": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ },
+ "description": "List of allowed nonResourceURLs"
+ }
+ }
+ },
+ "TrustedAccessRole": {
+ "type": "object",
+ "description": "Trusted access role definition.",
+ "properties": {
+ "sourceResourceType": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type of Azure resource"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Name of role, name is unique under a source resource type"
+ },
+ "rules": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/TrustedAccessRoleRule"
+ },
+ "x-ms-identifiers": [],
+ "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)."
+ }
+ }
+ },
+ "TrustedAccessRoleListResult": {
+ "type": "object",
+ "description": "List of trusted access roles",
+ "properties": {
+ "value": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/TrustedAccessRole"
+ },
+ "x-ms-identifiers": [
+ "sourceResourceType",
+ "name"
+ ],
+ "description": "Role list"
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TrustedAccessRoleBindingProperties": {
+ "type": "object",
+ "description": "Properties for trusted access role binding",
+ "required": [
+ "sourceResourceId",
+ "roles"
+ ],
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state of trusted access role binding.",
+ "enum": [
+ "Canceled",
+ "Deleting",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "TrustedAccessRoleBindingProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "sourceResourceId": {
+ "type": "string",
+ "description": "The ARM resource ID of source resource that trusted access is configured for."
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'."
+ }
+ }
+ },
+ "TrustedAccessRoleBinding": {
+ "type": "object",
+ "description": "Defines binding between a resource and role",
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TrustedAccessRoleBindingProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TrustedAccessRoleBindingListResult": {
+ "type": "object",
+ "description": "List of trusted access role bindings",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrustedAccessRoleBinding"
+ },
+ "description": "Role binding list"
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedClusterWorkloadAutoScalerProfile": {
+ "type": "object",
+ "description": "Workload Auto-scaler profile for the managed cluster.",
+ "properties": {
+ "keda": {
+ "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda"
+ },
+ "verticalPodAutoscaler": {
+ "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler"
+ }
+ }
+ },
+ "ManagedClusterWorkloadAutoScalerProfileKeda": {
+ "type": "object",
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable KEDA."
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable VPA. Default value is false.",
+ "default": false
+ },
+ "controlledValues": {
+ "type": "string",
+ "enum": [
+ "RequestsAndLimits",
+ "RequestsOnly"
+ ],
+ "x-ms-enum": {
+ "name": "ControlledValues",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "RequestsAndLimits",
+ "description": "Autoscaler will control resource requests and limits."
+ },
+ {
+ "value": "RequestsOnly",
+ "description": "Autoscaler will control resource requests only."
+ }
+ ]
+ },
+ "default": "RequestsAndLimits",
+ "description": "Controls which resource value autoscaler will change. Default value is RequestsAndLimits."
+ },
+ "updateMode": {
+ "type": "string",
+ "enum": [
+ "Off",
+ "Initial",
+ "Recreate",
+ "Auto"
+ ],
+ "x-ms-enum": {
+ "name": "UpdateMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Off",
+ "description": "Autoscaler never changes pod resources but provides recommendations."
+ },
+ {
+ "value": "Initial",
+ "description": "Autoscaler only assigns resources on pod creation and doesn't change them during the lifetime of the pod."
+ },
+ {
+ "value": "Recreate",
+ "description": "Autoscaler assigns resources on pod creation and updates pods that need further scaling during their lifetime by deleting and recreating."
+ },
+ {
+ "value": "Auto",
+ "description": "Autoscaler chooses the update mode. Autoscaler currently does the same as Recreate. In the future, it may take advantage of restart-free mechanisms once they are available."
+ }
+ ]
+ },
+ "default": "Off",
+ "title": "The update mode of the autoscaler.",
+ "description": "Each update mode level is a superset of the lower levels. Off (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)."
+ },
+ "currentOrchestratorVersion": {
+ "readOnly": true,
+ "type": "string",
+ "title": "The version of Kubernetes the Agent Pool is running.",
+ "description": "If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used."
+ },
+ "nodeImageVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of node image"
+ },
+ "upgradeSettings": {
+ "$ref": "#/definitions/AgentPoolUpgradeSettings",
+ "description": "Settings for upgrading the agentpool"
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current deployment or provisioning state."
+ },
+ "powerState": {
+ "title": "Whether the Agent Pool is running or stopped.",
+ "description": "When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded",
+ "$ref": "#/definitions/PowerState"
+ },
+ "availabilityZones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'."
+ },
+ "enableNodePublicIP": {
+ "type": "boolean",
+ "title": "Whether each node is allocated its own public IP.",
+ "description": "Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false."
+ },
+ "nodePublicIPPrefixID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Network/publicIPPrefixes"
+ }
+ ]
+ },
+ "title": "The public IP prefix ID which VM nodes should use IPs from.",
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}"
+ },
+ "scaleSetPriority": {
+ "$ref": "#/definitions/ScaleSetPriority",
+ "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'."
+ },
+ "scaleSetEvictionPolicy": {
+ "$ref": "#/definitions/ScaleSetEvictionPolicy",
+ "title": "The Virtual Machine Scale Set eviction policy to use.",
+ "description": "This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'."
+ },
+ "spotMaxPrice": {
+ "$ref": "#/definitions/SpotMaxPrice",
+ "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The tags to be persisted on the agent pool virtual machine scale set."
+ },
+ "nodeLabels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The node labels to be persisted across all nodes in agent pool."
+ },
+ "nodeTaints": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule."
+ },
+ "proximityPlacementGroupID": {
+ "$ref": "#/definitions/ProximityPlacementGroupID",
+ "description": "The ID for Proximity Placement Group."
+ },
+ "kubeletConfig": {
+ "$ref": "#/definitions/KubeletConfig",
+ "description": "The Kubelet configuration on the agent pool nodes."
+ },
+ "linuxOSConfig": {
+ "$ref": "#/definitions/LinuxOSConfig",
+ "description": "The OS configuration of Linux agent nodes."
+ },
+ "enableEncryptionAtHost": {
+ "type": "boolean",
+ "title": "Whether to enable host based OS and data drive encryption.",
+ "description": "This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption"
+ },
+ "enableUltraSSD": {
+ "type": "boolean",
+ "description": "Whether to enable UltraSSD"
+ },
+ "enableFIPS": {
+ "type": "boolean",
+ "title": "Whether to use a FIPS-enabled OS.",
+ "description": "See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details."
+ },
+ "gpuInstanceProfile": {
+ "$ref": "#/definitions/GPUInstanceProfile",
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot."
+ },
+ "hostGroupID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/hostGroups"
+ }
+ ]
+ },
+ "title": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set.",
+ "description": "This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)."
+ }
+ },
+ "description": "Properties for the container service agent pool profile."
+ },
+ "ManagedClusterAgentPoolProfile": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties"
+ }
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Unique name of the agent pool profile in the context of the subscription and resource group.",
+ "description": "Windows agent pool names must be 6 characters or less.",
+ "pattern": "^[a-z][a-z0-9]{0,11}$"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "Profile for the container service agent pool."
+ },
+ "AgentPoolType": {
+ "type": "string",
+ "enum": [
+ "VirtualMachineScaleSets",
+ "AvailabilitySet"
+ ],
+ "x-ms-enum": {
+ "name": "AgentPoolType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "VirtualMachineScaleSets",
+ "description": "Create an Agent Pool backed by a Virtual Machine Scale Set."
+ },
+ {
+ "value": "AvailabilitySet",
+ "description": "Use of this is strongly discouraged."
+ }
+ ]
+ },
+ "description": "The type of Agent Pool."
+ },
+ "AgentPoolMode": {
+ "type": "string",
+ "enum": [
+ "System",
+ "User"
+ ],
+ "x-ms-enum": {
+ "name": "AgentPoolMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "System",
+ "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory."
+ },
+ {
+ "value": "User",
+ "description": "User agent pools are primarily for hosting your application pods."
+ }
+ ]
+ },
+ "title": "The mode of an agent pool.",
+ "description": "A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools"
+ },
+ "AgentPoolListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AgentPool"
+ },
+ "description": "The list of agent pools."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of agent pool results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Agent Pools operation."
+ },
+ "AgentPoolUpgradeSettings": {
+ "type": "object",
+ "properties": {
+ "maxSurge": {
+ "type": "string",
+ "title": "The maximum number or percentage of nodes that are surged during upgrade.",
+ "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade"
+ }
+ },
+ "description": "Settings for upgrading an agentpool"
+ },
+ "AgentPool": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SubResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Properties of an agent pool.",
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "Agent Pool."
+ },
+ "ManagedClusterWindowsProfile": {
+ "type": "object",
+ "properties": {
+ "adminUsername": {
+ "type": "string",
+ "description": "Specifies the name of the administrator account.
**Restriction:** Cannot end in \".\"
**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".
**Minimum-length:** 1 character
**Max-length:** 20 characters"
+ },
+ "adminPassword": {
+ "type": "string",
+ "description": "Specifies the password of the administrator account.
**Minimum-length:** 8 characters
**Max-length:** 123 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\""
+ },
+ "licenseType": {
+ "type": "string",
+ "enum": [
+ "None",
+ "Windows_Server"
+ ],
+ "x-ms-enum": {
+ "name": "licenseType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No additional licensing is applied."
+ },
+ {
+ "value": "Windows_Server",
+ "description": "Enables Azure Hybrid User Benefits for Windows VMs."
+ }
+ ]
+ },
+ "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details."
+ },
+ "enableCSIProxy": {
+ "type": "boolean",
+ "title": "Whether to enable CSI proxy.",
+ "description": "For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)."
+ },
+ "gmsaProfile": {
+ "$ref": "#/definitions/WindowsGmsaProfile",
+ "description": "The Windows gMSA Profile in the Managed Cluster."
+ }
+ },
+ "required": [
+ "adminUsername"
+ ],
+ "description": "Profile for Windows VMs in the managed cluster."
+ },
+ "WindowsGmsaProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "title": "Whether to enable Windows gMSA.",
+ "description": "Specifies whether to enable Windows gMSA in the managed cluster."
+ },
+ "dnsServer": {
+ "type": "string",
+ "description": "Specifies the DNS server for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ },
+ "rootDomainName": {
+ "type": "string",
+ "description": "Specifies the root domain name for Windows gMSA.
Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster."
+ }
+ },
+ "description": "Windows gMSA Profile in the managed cluster."
+ },
+ "ContainerServiceLinuxProfile": {
+ "type": "object",
+ "properties": {
+ "adminUsername": {
+ "type": "string",
+ "description": "The administrator username to use for Linux VMs.",
+ "pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
+ },
+ "ssh": {
+ "$ref": "#/definitions/ContainerServiceSshConfiguration",
+ "description": "The SSH configuration for Linux-based VMs running on Azure."
+ }
+ },
+ "required": [
+ "adminUsername",
+ "ssh"
+ ],
+ "description": "Profile for Linux VMs in the container service cluster."
+ },
+ "ContainerServiceNetworkProfile": {
+ "type": "object",
+ "properties": {
+ "networkPlugin": {
+ "type": "string",
+ "enum": [
+ "azure",
+ "kubenet",
+ "none"
+ ],
+ "default": "kubenet",
+ "x-ms-enum": {
+ "name": "NetworkPlugin",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "azure",
+ "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information."
+ },
+ {
+ "value": "kubenet",
+ "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information."
+ },
+ {
+ "value": "none",
+ "description": "No CNI plugin is pre-installed. See [BYO CNI](https://docs.microsoft.com/en-us/azure/aks/use-byo-cni) for more information."
+ }
+ ]
+ },
+ "description": "Network plugin used for building the Kubernetes network."
+ },
+ "networkPolicy": {
+ "type": "string",
+ "enum": [
+ "calico",
+ "azure"
+ ],
+ "x-ms-enum": {
+ "name": "NetworkPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "calico",
+ "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information."
+ },
+ {
+ "value": "azure",
+ "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information."
+ }
+ ]
+ },
+ "description": "Network policy used for building the Kubernetes network."
+ },
+ "networkMode": {
+ "type": "string",
+ "enum": [
+ "transparent",
+ "bridge"
+ ],
+ "x-ms-enum": {
+ "name": "networkMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "transparent",
+ "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information."
+ },
+ {
+ "value": "bridge",
+ "description": "This is no longer supported"
+ }
+ ]
+ },
+ "title": "The network mode Azure CNI is configured with.",
+ "description": "This cannot be specified if networkPlugin is anything other than 'azure'."
+ },
+ "podCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "10.244.0.0/16",
+ "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used."
+ },
+ "serviceCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "10.0.0.0/16",
+ "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges."
+ },
+ "dnsServiceIP": {
+ "type": "string",
+ "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
+ "default": "10.0.0.10",
+ "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr."
+ },
+ "dockerBridgeCidr": {
+ "type": "string",
+ "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$",
+ "default": "172.17.0.1/16",
+ "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range."
+ },
+ "outboundType": {
+ "type": "string",
+ "enum": [
+ "loadBalancer",
+ "userDefinedRouting",
+ "managedNATGateway",
+ "userAssignedNATGateway"
+ ],
+ "x-ms-enum": {
+ "name": "outboundType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "loadBalancer",
+ "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)."
+ },
+ {
+ "value": "userDefinedRouting",
+ "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)."
+ },
+ {
+ "value": "managedNATGateway",
+ "description": "The AKS-managed NAT gateway is used for egress."
+ },
+ {
+ "value": "userAssignedNATGateway",
+ "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration."
+ }
+ ]
+ },
+ "default": "loadBalancer",
+ "title": "The outbound (egress) routing method.",
+ "description": "This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)."
+ },
+ "loadBalancerSku": {
+ "type": "string",
+ "enum": [
+ "standard",
+ "basic"
+ ],
+ "x-ms-enum": {
+ "name": "loadBalancerSku",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "standard",
+ "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article."
+ },
+ {
+ "value": "basic",
+ "description": "Use a basic Load Balancer with limited functionality."
+ }
+ ]
+ },
+ "title": "The load balancer sku for the managed cluster.",
+ "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs."
+ },
+ "loadBalancerProfile": {
+ "$ref": "#/definitions/ManagedClusterLoadBalancerProfile",
+ "description": "Profile of the cluster load balancer."
+ },
+ "natGatewayProfile": {
+ "$ref": "#/definitions/ManagedClusterNATGatewayProfile",
+ "description": "Profile of the cluster NAT gateway."
+ },
+ "podCidrs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The CIDR notation IP ranges from which to assign pod IPs.",
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking."
+ },
+ "serviceCidrs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The CIDR notation IP ranges from which to assign service cluster IPs.",
+ "description": "One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges."
+ },
+ "ipFamilies": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "The IP version to use for cluster networking and IP assignment.",
+ "enum": [
+ "IPv4",
+ "IPv6"
+ ],
+ "x-ms-enum": {
+ "name": "ipFamily",
+ "modelAsString": true
+ }
+ },
+ "title": "The IP families used to specify IP versions available to the cluster.",
+ "description": "IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6."
+ }
+ },
+ "description": "Profile of network configuration."
+ },
+ "MaintenanceConfigurationListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MaintenanceConfiguration"
+ },
+ "description": "The list of maintenance configurations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of maintenance configuration results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List maintenance configurations operation."
+ },
+ "MaintenanceConfiguration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/SubResource"
+ }
+ ],
+ "properties": {
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData",
+ "readOnly": true,
+ "description": "The system metadata relating to this resource."
+ },
+ "properties": {
+ "description": "Properties of a default maintenance configuration.",
+ "$ref": "#/definitions/MaintenanceConfigurationProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "title": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster.",
+ "description": "See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance."
+ },
+ "MaintenanceConfigurationProperties": {
+ "type": "object",
+ "properties": {
+ "timeInWeek": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TimeInWeek"
+ },
+ "x-ms-identifiers": [],
+ "title": "Time slots during the week when planned maintenance is allowed to proceed.",
+ "description": "If two array entries specify the same day of the week, the applied configuration is the union of times in both entries."
+ },
+ "notAllowedTime": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TimeSpan"
+ },
+ "x-ms-identifiers": [],
+ "description": "Time slots on which upgrade is not allowed."
+ }
+ },
+ "description": "Properties used to configure planned maintenance for a Managed Cluster."
+ },
+ "TimeInWeek": {
+ "type": "object",
+ "properties": {
+ "day": {
+ "$ref": "#/definitions/WeekDay",
+ "description": "The day of the week."
+ },
+ "hourSlots": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HourInDay"
+ },
+ "title": "A list of hours in the day used to identify a time range.",
+ "description": "Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range."
+ }
+ },
+ "description": "Time in a week."
+ },
+ "WeekDay": {
+ "type": "string",
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
+ "x-ms-enum": {
+ "name": "WeekDay",
+ "modelAsString": true
+ },
+ "description": "The weekday enum."
+ },
+ "HourInDay": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 23,
+ "minimum": 0,
+ "description": "Hour in a day."
+ },
+ "TimeSpan": {
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The start of a time span"
+ },
+ "end": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The end of a time span"
+ }
+ },
+ "title": "A time range.",
+ "description": "For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z."
+ },
+ "RunCommandRequest": {
+ "type": "object",
+ "properties": {
+ "command": {
+ "type": "string",
+ "description": "The command to run."
+ },
+ "context": {
+ "type": "string",
+ "description": "A base64 encoded zip file containing the files required by the command."
+ },
+ "clusterToken": {
+ "type": "string",
+ "description": "AuthToken issued for AKS AAD Server App."
+ }
+ },
+ "description": "A run command request",
+ "required": [
+ "command"
+ ]
+ },
+ "RunCommandResult": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The command id.",
+ "readOnly": true
+ },
+ "properties": {
+ "description": "Properties of command result.",
+ "$ref": "#/definitions/CommandResultProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "run command result."
+ },
+ "CommandResultProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "provisioning State"
+ },
+ "exitCode": {
+ "type": "integer",
+ "format": "int32",
+ "readOnly": true,
+ "description": "The exit code of the command"
+ },
+ "startedAt": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The time when the command started."
+ },
+ "finishedAt": {
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The time when the command finished."
+ },
+ "logs": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The command output."
+ },
+ "reason": {
+ "type": "string",
+ "readOnly": true,
+ "description": "An explanation of why provisioningState is set to failed (if so)."
+ }
+ },
+ "description": "The results of a run command"
+ },
+ "ManagedClusterNATGatewayProfile": {
+ "type": "object",
+ "properties": {
+ "managedOutboundIPProfile": {
+ "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile",
+ "description": "Profile of the managed outbound IP resources of the cluster NAT gateway."
+ },
+ "effectiveOutboundIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "The effective outbound IP resources of the cluster NAT gateway."
+ },
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 120,
+ "minimum": 4,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.",
+ "default": 4
+ }
+ },
+ "description": "Profile of the managed cluster NAT gateway."
+ },
+ "ManagedClusterManagedOutboundIPProfile": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 16,
+ "minimum": 1,
+ "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ",
+ "default": 1
+ }
+ },
+ "description": "Profile of the managed outbound IP resources of the managed cluster."
+ },
+ "ManagedClusterLoadBalancerProfile": {
+ "type": "object",
+ "properties": {
+ "managedOutboundIPs": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 100,
+ "minimum": 1,
+ "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ",
+ "default": 1
+ },
+ "countIPv6": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 100,
+ "minimum": 0,
+ "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ",
+ "default": 0
+ }
+ },
+ "description": "Desired managed outbound IPs for the cluster load balancer."
+ },
+ "outboundIPPrefixes": {
+ "type": "object",
+ "properties": {
+ "publicIPPrefixes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "A list of public IP prefix resources."
+ }
+ },
+ "description": "Desired outbound IP Prefix resources for the cluster load balancer."
+ },
+ "outboundIPs": {
+ "type": "object",
+ "properties": {
+ "publicIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "A list of public IP resources."
+ }
+ },
+ "description": "Desired outbound IP resources for the cluster load balancer."
+ },
+ "effectiveOutboundIPs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceReference"
+ },
+ "description": "The effective outbound IP resources of the cluster load balancer."
+ },
+ "allocatedOutboundPorts": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 64000,
+ "minimum": 0,
+ "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.",
+ "default": 0
+ },
+ "idleTimeoutInMinutes": {
+ "type": "integer",
+ "format": "int32",
+ "maximum": 120,
+ "minimum": 4,
+ "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.",
+ "default": 30
+ },
+ "enableMultipleStandardLoadBalancers": {
+ "type": "boolean",
+ "description": "Enable multiple standard load balancers per AKS cluster or not."
+ }
+ },
+ "description": "Profile of the managed cluster load balancer."
+ },
+ "ResourceReference": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "arm-id",
+ "description": "The fully qualified Azure resource id."
+ }
+ },
+ "description": "A reference to an Azure resource."
+ },
+ "ContainerServiceSshConfiguration": {
+ "type": "object",
+ "properties": {
+ "publicKeys": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerServiceSshPublicKey"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified."
+ }
+ },
+ "description": "SSH configuration for Linux-based VMs running on Azure.",
+ "required": [
+ "publicKeys"
+ ]
+ },
+ "ContainerServiceSshPublicKey": {
+ "type": "object",
+ "properties": {
+ "keyData": {
+ "type": "string",
+ "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
+ }
+ },
+ "required": [
+ "keyData"
+ ],
+ "description": "Contains information about SSH certificate public key data."
+ },
+ "ContainerServiceDiagnosticsProfile": {
+ "type": "object",
+ "properties": {
+ "vmDiagnostics": {
+ "$ref": "#/definitions/ContainerServiceVMDiagnostics",
+ "description": "Profile for diagnostics on the container service VMs."
+ }
+ },
+ "description": "Profile for diagnostics on the container service cluster.",
+ "required": [
+ "vmDiagnostics"
+ ]
+ },
+ "ContainerServiceVMDiagnostics": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the VM diagnostic agent is provisioned on the VM."
+ },
+ "storageUri": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URI of the storage account where diagnostics are stored."
+ }
+ },
+ "description": "Profile for diagnostics on the container service VMs.",
+ "required": [
+ "enabled"
+ ]
+ },
+ "ManagedClusterListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedCluster"
+ },
+ "description": "The list of managed clusters."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of managed cluster results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Managed Clusters operation."
+ },
+ "ManagedCluster": {
+ "type": "object",
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/ManagedClusterSKU",
+ "description": "The managed cluster SKU."
+ },
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "description": "The extended location of the Virtual Machine."
+ },
+ "identity": {
+ "$ref": "#/definitions/ManagedClusterIdentity",
+ "description": "The identity of the managed cluster, if configured."
+ },
+ "properties": {
+ "description": "Properties of a managed cluster.",
+ "$ref": "#/definitions/ManagedClusterProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "Managed cluster."
+ },
+ "ManagedClusterProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current provisioning state."
+ },
+ "powerState": {
+ "$ref": "#/definitions/PowerState",
+ "description": "The Power State of the cluster.",
+ "readOnly": true
+ },
+ "maxAgentPools": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "The max number of agent pools for the managed cluster."
+ },
+ "kubernetesVersion": {
+ "type": "string",
+ "title": "The version of Kubernetes specified by the user.",
+ "description": "Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details."
+ },
+ "currentKubernetesVersion": {
+ "readOnly": true,
+ "type": "string",
+ "title": "The version of Kubernetes the Managed Cluster is running.",
+ "description": "If kubernetesVersion was a fully specified version , this field will be exactly equal to it. If kubernetesVersion was , this field will contain the full version being used."
+ },
+ "dnsPrefix": {
+ "type": "string",
+ "title": "The DNS prefix of the Managed Cluster.",
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdnSubdomain": {
+ "type": "string",
+ "title": "The FQDN subdomain of the private cluster with custom private dns zone.",
+ "description": "This cannot be updated once the Managed Cluster has been created."
+ },
+ "fqdn": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The FQDN of the master pool."
+ },
+ "privateFQDN": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The FQDN of private cluster."
+ },
+ "azurePortalFQDN": {
+ "readOnly": true,
+ "type": "string",
+ "title": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.",
+ "description": "The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly."
+ },
+ "agentPoolProfiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterAgentPoolProfile"
+ },
+ "x-ms-identifiers": [],
+ "description": "The agent pool properties."
+ },
+ "linuxProfile": {
+ "$ref": "#/definitions/ContainerServiceLinuxProfile",
+ "description": "The profile for Linux VMs in the Managed Cluster."
+ },
+ "windowsProfile": {
+ "$ref": "#/definitions/ManagedClusterWindowsProfile",
+ "description": "The profile for Windows VMs in the Managed Cluster."
+ },
+ "servicePrincipalProfile": {
+ "$ref": "#/definitions/ManagedClusterServicePrincipalProfile",
+ "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs."
+ },
+ "addonProfiles": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/ManagedClusterAddonProfile"
+ },
+ "description": "The profile of managed cluster add-on."
+ },
+ "podIdentityProfile": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProfile",
+ "title": "The pod identity profile of the Managed Cluster.",
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration."
+ },
+ "oidcIssuerProfile": {
+ "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile",
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "nodeResourceGroup": {
+ "type": "string",
+ "description": "The name of the resource group containing agent pool nodes."
+ },
+ "enableRBAC": {
+ "type": "boolean",
+ "description": "Whether to enable Kubernetes Role-Based Access Control."
+ },
+ "enablePodSecurityPolicy": {
+ "type": "boolean",
+ "description": "(DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp."
+ },
+ "networkProfile": {
+ "$ref": "#/definitions/ContainerServiceNetworkProfile",
+ "description": "The network configuration profile."
+ },
+ "aadProfile": {
+ "$ref": "#/definitions/ManagedClusterAADProfile",
+ "description": "The Azure Active Directory configuration."
+ },
+ "autoUpgradeProfile": {
+ "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile",
+ "description": "The auto upgrade configuration."
+ },
+ "autoScalerProfile": {
+ "type": "object",
+ "properties": {
+ "balance-similar-node-groups": {
+ "type": "string",
+ "title": "Detects similar node pools and balances the number of nodes between them.",
+ "description": "Valid values are 'true' and 'false'"
+ },
+ "expander": {
+ "type": "string",
+ "enum": [
+ "least-waste",
+ "most-pods",
+ "priority",
+ "random"
+ ],
+ "x-ms-enum": {
+ "name": "expander",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "least-waste",
+ "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources."
+ },
+ {
+ "value": "most-pods",
+ "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once."
+ },
+ {
+ "value": "priority",
+ "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)."
+ },
+ {
+ "value": "random",
+ "description": "Used when you don't have a particular need for the node groups to scale differently."
+ }
+ ]
+ },
+ "title": "The expander to use when scaling up",
+ "description": "If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information."
+ },
+ "max-empty-bulk-delete": {
+ "type": "string",
+ "title": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer.",
+ "description": "The default is 10."
+ },
+ "max-graceful-termination-sec": {
+ "type": "string",
+ "title": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node.",
+ "description": "The default is 600."
+ },
+ "max-node-provision-time": {
+ "type": "string",
+ "title": "The maximum time the autoscaler waits for a node to be provisioned.",
+ "description": "The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "max-total-unready-percentage": {
+ "type": "string",
+ "title": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations.",
+ "description": "The default is 45. The maximum is 100 and the minimum is 0."
+ },
+ "new-pod-scale-up-delay": {
+ "type": "string",
+ "title": "Ignore unscheduled pods before they're a certain age.",
+ "description": "For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)."
+ },
+ "ok-total-unready-count": {
+ "type": "string",
+ "title": "The number of allowed unready nodes, irrespective of max-total-unready-percentage.",
+ "description": "This must be an integer. The default is 3."
+ },
+ "scan-interval": {
+ "type": "string",
+ "title": "How often cluster is reevaluated for scale up or down.",
+ "description": "The default is '10'. Values must be an integer number of seconds."
+ },
+ "scale-down-delay-after-add": {
+ "type": "string",
+ "title": "How long after scale up that scale down evaluation resumes",
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-delete": {
+ "type": "string",
+ "title": "How long after node deletion that scale down evaluation resumes.",
+ "description": "The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-delay-after-failure": {
+ "type": "string",
+ "title": "How long after scale down failure that scale down evaluation resumes.",
+ "description": "The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unneeded-time": {
+ "type": "string",
+ "title": "How long a node should be unneeded before it is eligible for scale down.",
+ "description": "The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-unready-time": {
+ "type": "string",
+ "title": "How long an unready node should be unneeded before it is eligible for scale down",
+ "description": "The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported."
+ },
+ "scale-down-utilization-threshold": {
+ "type": "string",
+ "title": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.",
+ "description": "The default is '0.5'."
+ },
+ "skip-nodes-with-local-storage": {
+ "type": "string",
+ "title": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath.",
+ "description": "The default is true."
+ },
+ "skip-nodes-with-system-pods": {
+ "type": "string",
+ "title": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods)",
+ "description": "The default is true."
+ }
+ },
+ "description": "Parameters to be applied to the cluster-autoscaler when enabled"
+ },
+ "apiServerAccessProfile": {
+ "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile",
+ "description": "The access profile for managed cluster API server."
+ },
+ "diskEncryptionSetID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/diskEncryptionSets"
+ }
+ ]
+ },
+ "title": "The Resource ID of the disk encryption set to use for enabling encryption at rest.",
+ "description": "This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'"
+ },
+ "identityProfile": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserAssignedIdentity"
+ },
+ "description": "Identities associated with the cluster."
+ },
+ "privateLinkResources": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ },
+ "description": "Private link resources associated with the cluster."
+ },
+ "disableLocalAccounts": {
+ "type": "boolean",
+ "title": "If local accounts should be disabled on the Managed Cluster.",
+ "description": "If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)."
+ },
+ "httpProxyConfig": {
+ "$ref": "#/definitions/ManagedClusterHTTPProxyConfig",
+ "description": "Configurations for provisioning the cluster with HTTP proxy servers."
+ },
+ "securityProfile": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfile",
+ "description": "Security profile for the managed cluster."
+ },
+ "storageProfile": {
+ "$ref": "#/definitions/ManagedClusterStorageProfile",
+ "description": "Storage profile for the managed cluster."
+ },
+ "publicNetworkAccess": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ },
+ "title": "PublicNetworkAccess of the managedCluster",
+ "description": "Allow or deny public network access for AKS"
+ },
+ "workloadAutoScalerProfile": {
+ "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile"
+ }
+ },
+ "description": "Properties of the managed cluster."
+ },
+ "PowerState": {
+ "type": "object",
+ "description": "Describes the Power State of the cluster",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "Tells whether the cluster is Running or Stopped",
+ "enum": [
+ "Running",
+ "Stopped"
+ ],
+ "x-ms-enum": {
+ "name": "code",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Running",
+ "description": "The cluster is running."
+ },
+ {
+ "value": "Stopped",
+ "description": "The cluster is stopped."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "ManagedClusterAPIServerAccessProfile": {
+ "type": "object",
+ "properties": {
+ "authorizedIPRanges": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "The IP ranges authorized to access the Kubernetes API server.",
+ "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)."
+ },
+ "enablePrivateCluster": {
+ "type": "boolean",
+ "title": "Whether to create the cluster as a private cluster or not.",
+ "description": "For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)."
+ },
+ "privateDNSZone": {
+ "type": "string",
+ "title": "The private DNS zone mode for the cluster.",
+ "description": "The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'."
+ },
+ "enablePrivateClusterPublicFQDN": {
+ "type": "boolean",
+ "description": "Whether to create additional public FQDN for private cluster or not."
+ },
+ "disableRunCommand": {
+ "type": "boolean",
+ "description": "Whether to disable run command for the cluster or not."
+ }
+ },
+ "description": "Access profile for managed cluster API server."
+ },
+ "ManagedClusterIdentity": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of the system assigned identity which is used by master components."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant id of the system assigned identity which is used by master components."
+ },
+ "type": {
+ "type": "string",
+ "title": "The type of identity used for the managed cluster.",
+ "description": "For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "SystemAssigned",
+ "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources."
+ },
+ {
+ "value": "UserAssigned",
+ "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources."
+ },
+ {
+ "value": "None",
+ "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead."
+ }
+ ]
+ }
+ },
+ "userAssignedIdentities": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ "title": "The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed.",
+ "description": "The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the managed cluster."
+ },
+ "UserAssignedIdentity": {
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities"
+ }
+ ]
+ },
+ "description": "The resource ID of the user assigned identity."
+ },
+ "clientId": {
+ "type": "string",
+ "description": "The client ID of the user assigned identity."
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the user assigned identity."
+ }
+ },
+ "description": "Details about a user assigned identity."
+ },
+ "ManagedClusterAccessProfile": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AccessProfile of a managed cluster.",
+ "$ref": "#/definitions/AccessProfile",
+ "x-ms-client-flatten": true
+ }
+ },
+ "description": "Managed cluster Access Profile.",
+ "x-ms-azure-resource": false
+ },
+ "AccessProfile": {
+ "type": "object",
+ "properties": {
+ "kubeConfig": {
+ "type": "string",
+ "format": "byte",
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "Profile for enabling a user to access a managed cluster."
+ },
+ "ManagedClusterPoolUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "name": {
+ "type": "string",
+ "description": "The Agent Pool name."
+ },
+ "osType": {
+ "$ref": "#/definitions/OSType"
+ },
+ "upgrades": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether the Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of orchestrator types and versions available for upgrade."
+ }
+ },
+ "required": [
+ "kubernetesVersion",
+ "osType"
+ ],
+ "description": "The list of available upgrade versions."
+ },
+ "ManagedClusterUpgradeProfileProperties": {
+ "type": "object",
+ "properties": {
+ "controlPlaneProfile": {
+ "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile",
+ "description": "The list of available upgrade versions for the control plane."
+ },
+ "agentPoolProfiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of available upgrade versions for agent pools."
+ }
+ },
+ "required": [
+ "controlPlaneProfile",
+ "agentPoolProfiles"
+ ],
+ "description": "Control plane and agent pool upgrade profiles."
+ },
+ "ManagedClusterAutoUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "upgradeChannel": {
+ "type": "string",
+ "enum": [
+ "rapid",
+ "stable",
+ "patch",
+ "node-image",
+ "none"
+ ],
+ "x-ms-enum": {
+ "name": "upgradeChannel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "rapid",
+ "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1."
+ },
+ {
+ "value": "stable",
+ "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6."
+ },
+ {
+ "value": "patch",
+ "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9."
+ },
+ {
+ "value": "node-image",
+ "description": "Automatically upgrade the node image to the latest version available. Microsoft provides patches and new images for image nodes frequently (usually weekly), but your running nodes won't get the new images unless you do a node image upgrade. Turning on the node-image channel will automatically update your node images whenever a new version is available."
+ },
+ {
+ "value": "none",
+ "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes."
+ }
+ ]
+ },
+ "title": "The upgrade channel for auto upgrade. The default is 'none'.",
+ "description": "For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)."
+ }
+ },
+ "description": "Auto upgrade profile for a managed cluster."
+ },
+ "ManagedClusterAADProfile": {
+ "type": "object",
+ "properties": {
+ "managed": {
+ "type": "boolean",
+ "description": "Whether to enable managed AAD."
+ },
+ "enableAzureRBAC": {
+ "type": "boolean",
+ "description": "Whether to enable Azure RBAC for Kubernetes authorization."
+ },
+ "adminGroupObjectIDs": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of AAD group object IDs that will have admin role of the cluster."
+ },
+ "clientAppID": {
+ "type": "string",
+ "description": "The client AAD application ID."
+ },
+ "serverAppID": {
+ "type": "string",
+ "description": "The server AAD application ID."
+ },
+ "serverAppSecret": {
+ "type": "string",
+ "description": "The server AAD application secret."
+ },
+ "tenantID": {
+ "type": "string",
+ "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription."
+ }
+ },
+ "title": "AADProfile specifies attributes for Azure Active Directory integration.",
+ "description": "For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)."
+ },
+ "ManagedClusterAddonProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the add-on is enabled or not."
+ },
+ "config": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Key-value pairs for configuring an add-on."
+ },
+ "identity": {
+ "readOnly": true,
+ "description": "Information of user assigned identity used by this add-on.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/UserAssignedIdentity"
+ }
+ ]
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "description": "A Kubernetes add-on profile for a managed cluster."
+ },
+ "ManagedClusterPodIdentity": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the pod identity."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the pod identity."
+ },
+ "bindingSelector": {
+ "type": "string",
+ "description": "The binding selector to use for the AzureIdentityBinding resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/UserAssignedIdentity",
+ "description": "The user assigned identity details."
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state of the pod identity.",
+ "enum": [
+ "Assigned",
+ "Canceled",
+ "Deleting",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterPodIdentityProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "provisioningInfo": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError",
+ "description": "Pod identity assignment error (if any)."
+ }
+ }
+ }
+ },
+ "required": [
+ "name",
+ "namespace",
+ "identity"
+ ],
+ "description": "Details about the pod identity assigned to the Managed Cluster."
+ },
+ "ManagedClusterPodIdentityProvisioningError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody",
+ "description": "Details about the error."
+ }
+ },
+ "description": "An error response from the pod identity provisioning."
+ },
+ "ManagedClusterPodIdentityProvisioningErrorBody": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody"
+ },
+ "x-ms-identifiers": [],
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the pod identity provisioning."
+ },
+ "ManagedClusterPodIdentityException": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the pod identity exception."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the pod identity exception."
+ },
+ "podLabels": {
+ "type": "object",
+ "description": "The pod labels to match.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "namespace",
+ "podLabels"
+ ],
+ "title": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server.",
+ "description": "See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details."
+ },
+ "ManagedClusterPodIdentityProfile": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the pod identity addon is enabled."
+ },
+ "allowNetworkPluginKubenet": {
+ "type": "boolean",
+ "title": "Whether pod identity is allowed to run on clusters with Kubenet networking.",
+ "description": "Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information."
+ },
+ "userAssignedIdentities": {
+ "description": "The pod identities to use in the cluster.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentity"
+ },
+ "x-ms-identifiers": []
+ },
+ "userAssignedIdentityExceptions": {
+ "description": "The pod identity exceptions to allow.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedClusterPodIdentityException"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "title": "The pod identity profile of the Managed Cluster.",
+ "description": "See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration."
+ },
+ "ManagedClusterOIDCIssuerProfile": {
+ "type": "object",
+ "properties": {
+ "issuerURL": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The OIDC issuer url of the Managed Cluster."
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the OIDC issuer is enabled."
+ }
+ },
+ "description": "The OIDC issuer profile of the Managed Cluster."
+ },
+ "ManagedClusterUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the upgrade profile."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the upgrade profile."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the upgrade profile."
+ },
+ "properties": {
+ "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties",
+ "description": "The properties of the upgrade profile.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available upgrades for compute pools."
+ },
+ "AgentPoolUpgradeProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the agent pool upgrade profile."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the agent pool upgrade profile."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the agent pool upgrade profile."
+ },
+ "properties": {
+ "$ref": "#/definitions/AgentPoolUpgradeProfileProperties",
+ "description": "The properties of the agent pool upgrade profile.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available upgrades for an agent pool."
+ },
+ "AgentPoolUpgradeProfileProperties": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "osType": {
+ "$ref": "#/definitions/OSType"
+ },
+ "upgrades": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether the Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of orchestrator types and versions available for upgrade."
+ },
+ "latestNodeImageVersion": {
+ "type": "string",
+ "description": "The latest AKS supported node image version."
+ }
+ },
+ "required": [
+ "kubernetesVersion",
+ "osType"
+ ],
+ "description": "The list of available upgrade versions."
+ },
+ "AgentPoolAvailableVersions": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the agent pool version list."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the agent pool version list."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Type of the agent pool version list."
+ },
+ "properties": {
+ "$ref": "#/definitions/AgentPoolAvailableVersionsProperties",
+ "description": "Properties of agent pool available versions.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The list of available versions for an agent pool."
+ },
+ "AgentPoolAvailableVersionsProperties": {
+ "type": "object",
+ "properties": {
+ "agentPoolVersions": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "default": {
+ "type": "boolean",
+ "description": "Whether this version is the default agent pool version."
+ },
+ "kubernetesVersion": {
+ "type": "string",
+ "description": "The Kubernetes version (major.minor.patch)."
+ },
+ "isPreview": {
+ "type": "boolean",
+ "description": "Whether Kubernetes version is currently in preview."
+ }
+ }
+ },
+ "x-ms-identifiers": [],
+ "description": "List of versions available for agent pool."
+ }
+ },
+ "description": "The list of available agent pool versions."
+ },
+ "OSType": {
+ "type": "string",
+ "default": "Linux",
+ "enum": [
+ "Linux",
+ "Windows"
+ ],
+ "x-ms-enum": {
+ "name": "OSType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Linux",
+ "description": "Use Linux."
+ },
+ {
+ "value": "Windows",
+ "description": "Use Windows."
+ }
+ ]
+ },
+ "description": "The operating system type. The default is Linux."
+ },
+ "OSSKU": {
+ "type": "string",
+ "enum": [
+ "Ubuntu",
+ "CBLMariner",
+ "Windows2019",
+ "Windows2022"
+ ],
+ "x-ms-enum": {
+ "name": "OSSKU",
+ "modelAsString": true
+ },
+ "description": "Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows."
+ },
+ "ScaleSetPriority": {
+ "type": "string",
+ "default": "Regular",
+ "enum": [
+ "Spot",
+ "Regular"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleSetPriority",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Spot",
+ "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information."
+ },
+ {
+ "value": "Regular",
+ "description": "Regular VMs will be used."
+ }
+ ]
+ },
+ "description": "The Virtual Machine Scale Set priority."
+ },
+ "ScaleSetEvictionPolicy": {
+ "type": "string",
+ "default": "Delete",
+ "enum": [
+ "Delete",
+ "Deallocate"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleSetEvictionPolicy",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Delete",
+ "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted."
+ },
+ {
+ "value": "Deallocate",
+ "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading."
+ }
+ ]
+ },
+ "title": "The Virtual Machine Scale Set eviction policy.",
+ "description": "The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)"
+ },
+ "SpotMaxPrice": {
+ "type": "number",
+ "default": -1,
+ "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
+ "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
+ },
+ "ScaleDownMode": {
+ "type": "string",
+ "enum": [
+ "Delete",
+ "Deallocate"
+ ],
+ "x-ms-enum": {
+ "name": "ScaleDownMode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Delete",
+ "description": "Create new instances during scale up and remove instances during scale down."
+ },
+ {
+ "value": "Deallocate",
+ "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down."
+ }
+ ]
+ },
+ "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)."
+ },
+ "ProximityPlacementGroupID": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.Compute/proximityPlacementGroups"
+ }
+ ]
+ },
+ "description": "The ID for Proximity Placement Group."
+ },
+ "CredentialResults": {
+ "type": "object",
+ "properties": {
+ "kubeconfigs": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/CredentialResult"
+ },
+ "x-ms-identifiers": [],
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "The list credential result response."
+ },
+ "CredentialResult": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the credential."
+ },
+ "value": {
+ "type": "string",
+ "format": "byte",
+ "readOnly": true,
+ "description": "Base64-encoded Kubernetes configuration file."
+ }
+ },
+ "description": "The credential result response."
+ },
+ "CloudError": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody",
+ "description": "Details about the error."
+ }
+ },
+ "description": "An error response from the Container service."
+ },
+ "CloudErrorBody": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "x-ms-identifiers": [],
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the Container service."
+ },
+ "ManagedClusterSKU": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of a managed cluster SKU.",
+ "enum": [
+ "Basic"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterSKUName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "type": "string",
+ "title": "The tier of a managed cluster SKU.",
+ "description": "If not specified, the default is 'Free'. See [uptime SLA](https://docs.microsoft.com/azure/aks/uptime-sla) for more details.",
+ "enum": [
+ "Paid",
+ "Free"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedClusterSKUTier",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Paid",
+ "description": "Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones."
+ },
+ {
+ "value": "Free",
+ "description": "No guaranteed SLA, no additional charges. Free tier clusters have an SLO of 99.5%."
+ }
+ ]
+ }
+ }
+ },
+ "description": "The SKU of a Managed Cluster."
+ },
+ "PrivateEndpointConnectionListResult": {
+ "type": "object",
+ "description": "A list of private endpoint connections",
+ "properties": {
+ "value": {
+ "description": "The collection value.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "A private endpoint connection",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the private endpoint connection."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection.",
+ "externalDocs": {
+ "url": "https://aka.ms/search-naming-rules"
+ }
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource type."
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "description": "The properties of a private endpoint connection.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "PrivateEndpointConnectionProperties": {
+ "type": "object",
+ "description": "Properties of a private endpoint connection.",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Canceled",
+ "Creating",
+ "Deleting",
+ "Failed",
+ "Succeeded"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private endpoint."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ }
+ },
+ "required": [
+ "privateLinkServiceConnectionState"
+ ]
+ },
+ "PrivateEndpoint": {
+ "type": "object",
+ "description": "Private endpoint which a connection belongs to.",
+ "properties": {
+ "id": {
+ "description": "The resource ID of the private endpoint",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnectionState": {
+ "description": "The state of a private link service connection.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected",
+ "Disconnected"
+ ],
+ "type": "string",
+ "description": "The private link service connection status.",
+ "x-ms-enum": {
+ "name": "ConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "description": {
+ "type": "string",
+ "description": "The private link service connection description."
+ }
+ }
+ },
+ "PrivateLinkResourcesListResult": {
+ "type": "object",
+ "description": "A list of private link resources",
+ "properties": {
+ "value": {
+ "description": "The collection value.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A private link resource",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the private link resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the private link resource.",
+ "externalDocs": {
+ "url": "https://aka.ms/search-naming-rules"
+ }
+ },
+ "type": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "groupId": {
+ "type": "string",
+ "description": "The group ID of the resource."
+ },
+ "requiredMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The RequiredMembers of the resource"
+ },
+ "privateLinkServiceID": {
+ "readOnly": true,
+ "type": "string",
+ "format": "arm-id",
+ "description": "The private link service ID of the resource, this field is exposed only to NRP internally."
+ }
+ }
+ },
+ "OSDiskType": {
+ "type": "string",
+ "enum": [
+ "Managed",
+ "Ephemeral"
+ ],
+ "x-ms-enum": {
+ "name": "OSDiskType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Managed",
+ "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency."
+ },
+ {
+ "value": "Ephemeral",
+ "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades."
+ }
+ ]
+ },
+ "title": "The OS disk type to be used for machines in the agent pool.",
+ "description": "The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)."
+ },
+ "KubeletDiskType": {
+ "type": "string",
+ "enum": [
+ "OS",
+ "Temporary"
+ ],
+ "x-ms-enum": {
+ "name": "KubeletDiskType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "OS",
+ "description": "Kubelet will use the OS disk for its data."
+ },
+ {
+ "value": "Temporary",
+ "description": "Kubelet will use the temporary disk for its data."
+ }
+ ]
+ },
+ "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage."
+ },
+ "WorkloadRuntime": {
+ "type": "string",
+ "enum": [
+ "OCIContainer",
+ "WasmWasi"
+ ],
+ "x-ms-enum": {
+ "name": "WorkloadRuntime",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "OCIContainer",
+ "description": "Nodes will use Kubelet to run standard OCI container workloads."
+ },
+ {
+ "value": "WasmWasi",
+ "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)."
+ }
+ ]
+ },
+ "description": "Determines the type of workload a node can run."
+ },
+ "KubeletConfig": {
+ "title": "Kubelet configurations of agent nodes.",
+ "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.",
+ "type": "object",
+ "properties": {
+ "cpuManagerPolicy": {
+ "type": "string",
+ "title": "The CPU Manager policy to use.",
+ "description": "The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'."
+ },
+ "cpuCfsQuota": {
+ "type": "boolean",
+ "title": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits.",
+ "description": "The default is true."
+ },
+ "cpuCfsQuotaPeriod": {
+ "type": "string",
+ "title": "The CPU CFS quota period value.",
+ "description": "The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'."
+ },
+ "imageGcHighThreshold": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The percent of disk usage after which image garbage collection is always run.",
+ "description": "To disable image garbage collection, set to 100. The default is 85%"
+ },
+ "imageGcLowThreshold": {
+ "type": "integer",
+ "format": "int32",
+ "title": "The percent of disk usage before which image garbage collection is never run.",
+ "description": "This cannot be set higher than imageGcHighThreshold. The default is 80%"
+ },
+ "topologyManagerPolicy": {
+ "type": "string",
+ "title": "The Topology Manager policy to use.",
+ "description": "For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'."
+ },
+ "allowedUnsafeSysctls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)."
+ },
+ "failSwapOn": {
+ "type": "boolean",
+ "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node."
+ },
+ "containerLogMaxSizeMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated."
+ },
+ "containerLogMaxFiles": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.",
+ "minimum": 2
+ },
+ "podMaxPids": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of processes per pod."
+ }
+ }
+ },
+ "LinuxOSConfig": {
+ "title": "OS configurations of Linux agent nodes.",
+ "description": "See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.",
+ "type": "object",
+ "properties": {
+ "sysctls": {
+ "$ref": "#/definitions/SysctlConfig",
+ "description": "Sysctl settings for Linux agent nodes."
+ },
+ "transparentHugePageEnabled": {
+ "type": "string",
+ "title": "Whether transparent hugepages are enabled.",
+ "description": "Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "transparentHugePageDefrag": {
+ "type": "string",
+ "title": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available.",
+ "description": "Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)."
+ },
+ "swapFileSizeMB": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The size in MB of a swap file that will be created on each node."
+ }
+ }
+ },
+ "SysctlConfig": {
+ "description": "Sysctl settings for Linux agent nodes.",
+ "type": "object",
+ "properties": {
+ "netCoreSomaxconn": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.somaxconn."
+ },
+ "netCoreNetdevMaxBacklog": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.netdev_max_backlog."
+ },
+ "netCoreRmemDefault": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.rmem_default."
+ },
+ "netCoreRmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.rmem_max."
+ },
+ "netCoreWmemDefault": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.wmem_default."
+ },
+ "netCoreWmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.wmem_max."
+ },
+ "netCoreOptmemMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.core.optmem_max."
+ },
+ "netIpv4TcpMaxSynBacklog": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog."
+ },
+ "netIpv4TcpMaxTwBuckets": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets."
+ },
+ "netIpv4TcpFinTimeout": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_fin_timeout."
+ },
+ "netIpv4TcpKeepaliveTime": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_time."
+ },
+ "netIpv4TcpKeepaliveProbes": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_probes."
+ },
+ "netIpv4TcpkeepaliveIntvl": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl."
+ },
+ "netIpv4TcpTwReuse": {
+ "type": "boolean",
+ "description": "Sysctl setting net.ipv4.tcp_tw_reuse."
+ },
+ "netIpv4IpLocalPortRange": {
+ "type": "string",
+ "description": "Sysctl setting net.ipv4.ip_local_port_range."
+ },
+ "netIpv4NeighDefaultGcThresh1": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1."
+ },
+ "netIpv4NeighDefaultGcThresh2": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2."
+ },
+ "netIpv4NeighDefaultGcThresh3": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3."
+ },
+ "netNetfilterNfConntrackMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.netfilter.nf_conntrack_max."
+ },
+ "netNetfilterNfConntrackBuckets": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting net.netfilter.nf_conntrack_buckets."
+ },
+ "fsInotifyMaxUserWatches": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.inotify.max_user_watches."
+ },
+ "fsFileMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.file-max."
+ },
+ "fsAioMaxNr": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.aio-max-nr."
+ },
+ "fsNrOpen": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting fs.nr_open."
+ },
+ "kernelThreadsMax": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting kernel.threads-max."
+ },
+ "vmMaxMapCount": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.max_map_count."
+ },
+ "vmSwappiness": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.swappiness."
+ },
+ "vmVfsCachePressure": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sysctl setting vm.vfs_cache_pressure."
+ }
+ }
+ },
+ "ManagedClusterHTTPProxyConfig": {
+ "description": "Cluster HTTP proxy configuration.",
+ "type": "object",
+ "properties": {
+ "httpProxy": {
+ "type": "string",
+ "description": "The HTTP proxy server endpoint to use."
+ },
+ "httpsProxy": {
+ "type": "string",
+ "description": "The HTTPS proxy server endpoint to use."
+ },
+ "noProxy": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The endpoints that should not go through proxy."
+ },
+ "trustedCa": {
+ "type": "string",
+ "description": "Alternative CA cert to use for connecting to proxy servers."
+ }
+ }
+ },
+ "GPUInstanceProfile": {
+ "type": "string",
+ "enum": [
+ "MIG1g",
+ "MIG2g",
+ "MIG3g",
+ "MIG4g",
+ "MIG7g"
+ ],
+ "x-ms-enum": {
+ "name": "GPUInstanceProfile ",
+ "modelAsString": true
+ },
+ "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
+ },
+ "ExtendedLocationType": {
+ "type": "string",
+ "description": "The type of extendedLocation.",
+ "enum": [
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "ExtendedLocationTypes",
+ "modelAsString": true
+ }
+ },
+ "ExtendedLocation": {
+ "type": "object",
+ "description": "The complex type of the extended location.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the extended location."
+ },
+ "type": {
+ "$ref": "#/definitions/ExtendedLocationType",
+ "description": "The type of the extended location."
+ }
+ }
+ },
+ "OSOptionProperty": {
+ "type": "object",
+ "properties": {
+ "os-type": {
+ "type": "string",
+ "description": "The OS type."
+ },
+ "enable-fips-image": {
+ "type": "boolean",
+ "description": "Whether the image is FIPS-enabled."
+ }
+ },
+ "required": [
+ "os-type",
+ "enable-fips-image"
+ ],
+ "description": "OS option property."
+ },
+ "OSOptionPropertyList": {
+ "type": "object",
+ "properties": {
+ "osOptionPropertyList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OSOptionProperty"
+ },
+ "x-ms-identifiers": [],
+ "description": "The list of OS options."
+ }
+ },
+ "required": [
+ "osOptionPropertyList"
+ ],
+ "description": "The list of OS option properties."
+ },
+ "OSOptionProfile": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the OS option resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the OS option resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the OS option resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/OSOptionPropertyList",
+ "description": "The list of OS options.",
+ "x-ms-client-flatten": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "The OS option profile."
+ },
+ "EndpointDependency": {
+ "description": "A domain name that AKS agent nodes are reaching at.",
+ "type": "object",
+ "properties": {
+ "domainName": {
+ "description": "The domain name of the dependency.",
+ "type": "string"
+ },
+ "endpointDetails": {
+ "description": "The Ports and Protocols used when connecting to domainName.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDetail"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "EndpointDetail": {
+ "description": "connect information from the AKS agent nodes to a single endpoint.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "An IP Address that Domain Name currently resolves to.",
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port an endpoint is connected to.",
+ "type": "integer"
+ },
+ "protocol": {
+ "description": "The protocol used for connection",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the detail",
+ "type": "string"
+ }
+ }
+ },
+ "OutboundEnvironmentEndpoint": {
+ "description": "Egress endpoints which AKS agent nodes connect to for common purpose.",
+ "type": "object",
+ "properties": {
+ "category": {
+ "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "The endpoints that AKS agent nodes connect to",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDependency"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "OutboundEnvironmentEndpointCollection": {
+ "description": "Collection of OutboundEnvironmentEndpoint",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpoint"
+ },
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ManagedClusterSecurityProfile": {
+ "type": "object",
+ "properties": {
+ "defender": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileDefender",
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "azureKeyVaultKms": {
+ "$ref": "#/definitions/AzureKeyVaultKms",
+ "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile."
+ }
+ },
+ "description": "Security profile for the container service cluster."
+ },
+ "AzureKeyVaultKms": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Azure Key Vault key management service. The default is false."
+ },
+ "keyId": {
+ "type": "string",
+ "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty."
+ },
+ "keyVaultNetworkAccess": {
+ "type": "string",
+ "enum": [
+ "Public",
+ "Private"
+ ],
+ "default": "Public",
+ "x-ms-enum": {
+ "name": "KeyVaultNetworkAccessTypes",
+ "modelAsString": true
+ },
+ "title": "Network access of the key vault",
+ "description": "Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`."
+ },
+ "keyVaultResourceId": {
+ "type": "string",
+ "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty."
+ }
+ },
+ "description": "Azure Key Vault key management service settings for the security profile."
+ },
+ "ManagedClusterStorageProfile": {
+ "type": "object",
+ "properties": {
+ "diskCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver",
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "fileCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver",
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "snapshotController": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController",
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "blobCSIDriver": {
+ "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver",
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ }
+ },
+ "description": "Storage profile for the container service cluster."
+ },
+ "ManagedClusterSecurityProfileDefender": {
+ "type": "object",
+ "properties": {
+ "logAnalyticsWorkspaceResourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "x-ms-arm-id-details": {
+ "allowedResources": [
+ {
+ "type": "Microsoft.OperationalInsights/workspaces"
+ }
+ ]
+ },
+ "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty."
+ },
+ "securityMonitoring": {
+ "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring",
+ "description": "Microsoft Defender threat detection for Cloud settings for the security profile."
+ }
+ },
+ "description": "Microsoft Defender settings for the security profile."
+ },
+ "ManagedClusterSecurityProfileDefenderSecurityMonitoring": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Defender threat detection"
+ }
+ },
+ "description": "Microsoft Defender settings for the security profile threat detection."
+ },
+ "ManagedClusterStorageProfileDiskCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureDisk CSI Driver. The default value is true."
+ }
+ },
+ "description": "AzureDisk CSI Driver settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileFileCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureFile CSI Driver. The default value is true."
+ }
+ },
+ "description": "AzureFile CSI Driver settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileSnapshotController": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable Snapshot Controller. The default value is true."
+ }
+ },
+ "description": "Snapshot Controller settings for the storage profile."
+ },
+ "ManagedClusterStorageProfileBlobCSIDriver": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable AzureBlob CSI Driver. The default value is false."
+ }
+ },
+ "description": "AzureBlob CSI Driver settings for the storage profile."
+ },
+ "CreationData": {
+ "description": "Data used when creating a target resource from a source resource.",
+ "type": "object",
+ "properties": {
+ "sourceResourceId": {
+ "type": "string",
+ "format": "arm-id",
+ "description": "This is the ARM ID of the source object to be used to create the target object."
+ }
+ }
+ },
+ "SnapshotListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Snapshot"
+ },
+ "description": "The list of snapshots."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of snapshot results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Snapshots operation."
+ },
+ "Snapshot": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Properties of a snapshot.",
+ "$ref": "#/definitions/SnapshotProperties",
+ "x-ms-client-flatten": true
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "description": "A node pool snapshot resource."
+ },
+ "SnapshotProperties": {
+ "type": "object",
+ "properties": {
+ "creationData": {
+ "$ref": "#/definitions/CreationData",
+ "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot."
+ },
+ "snapshotType": {
+ "$ref": "#/definitions/SnapshotType"
+ },
+ "kubernetesVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of Kubernetes."
+ },
+ "nodeImageVersion": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The version of node image."
+ },
+ "osType": {
+ "readOnly": true,
+ "$ref": "#/definitions/OSType"
+ },
+ "osSku": {
+ "readOnly": true,
+ "$ref": "#/definitions/OSSKU"
+ },
+ "vmSize": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The size of the VM."
+ },
+ "enableFIPS": {
+ "readOnly": true,
+ "type": "boolean",
+ "description": "Whether to use a FIPS-enabled OS."
+ }
+ },
+ "description": "Properties used to configure a node pool snapshot."
+ },
+ "SnapshotType": {
+ "type": "string",
+ "default": "NodePool",
+ "enum": [
+ "NodePool"
+ ],
+ "x-ms-enum": {
+ "name": "SnapshotType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NodePool",
+ "description": "The snapshot is a snapshot of a node pool."
+ }
+ ]
+ },
+ "description": "The type of a snapshot. The default is NodePool."
+ },
+ "ManagedClusterWorkloadAutoScalerProfile": {
+ "type": "object",
+ "description": "Workload Auto-scaler profile for the managed cluster.",
+ "properties": {
+ "keda": {
+ "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda"
+ }
+ }
+ },
+ "ManagedClusterWorkloadAutoScalerProfileKeda": {
+ "type": "object",
+ "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether to enable KEDA."
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ }
+ },
+ "parameters": {
+ "ResourceNameParameter": {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 63,
+ "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$",
+ "description": "The name of the managed cluster resource.",
+ "x-ms-parameter-location": "method"
+ },
+ "ResourceTypeParameter": {
+ "name": "resource-type",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The resource type for which the OS options needs to be returned",
+ "x-ms-parameter-location": "method"
+ },
+ "ServerFqdnParameter": {
+ "name": "server-fqdn",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "server fqdn type for credentials to be returned",
+ "x-ms-parameter-location": "method"
+ },
+ "CredentialFormatParameter": {
+ "name": "format",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "exec",
+ "azure"
+ ],
+ "x-ms-enum": {
+ "name": "format",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "azure",
+ "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26."
+ },
+ {
+ "value": "exec",
+ "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path."
+ }
+ ]
+ },
+ "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md
index cfa11d3eb145..aafc00cfcc6b 100644
--- a/specification/containerservice/resource-manager/readme.java.md
+++ b/specification/containerservice/resource-manager/readme.java.md
@@ -64,6 +64,34 @@ batch:
- tag: package-preview-2022-09
- tag: package-2022-09
- tag: package-preview-2022-10
+ - tag: package-preview-2022-11
+ - tag: package-2022-11
+```
+
+### Tag: package-2022-11 and java
+
+These settings apply only when `--tag=package-2022-11` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2022-11' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.containerservice.v2022_11_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2022_11_01
+regenerate-manager: true
+generate-interface: true
+```
+
+### Tag: package-preview-2022-11 and java
+
+These settings apply only when `--tag=package-preview-2022-11` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-preview-2022-11' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.containerservice.v2022_11_02_preview
+ output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2022_11_02_preview
+regenerate-manager: true
+generate-interface: true
```
### Tag: package-preview-2022-10 and java
diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md
index 118429551764..8136b05cbf64 100644
--- a/specification/containerservice/resource-manager/readme.md
+++ b/specification/containerservice/resource-manager/readme.md
@@ -34,7 +34,35 @@ These are the global settings for the ContainerServices API.
``` yaml
openapi-type: arm
-tag: package-preview-2022-10
+tag: package-2022-11
+```
+
+### Tag: package-2022-11
+
+These settings apply only when `--tag=package-2022-11` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-11'
+input-file:
+ - Microsoft.ContainerService/stable/2022-11-01/managedClusters.json
+```
+
+### Tag: package-preview-2022-11-only
+
+These settings apply only when `--tag=package-preview-2022-11-only` is specified on the command line.
+
+``` yaml $(tag) == 'package-preview-2022-11-only'
+input-file:
+ - Microsoft.ContainerService/preview/2022-11-02-preview/managedClusters.json
+```
+
+### Tag: package-preview-2022-11
+
+These settings apply only when `--tag=package-preview-2022-11` is specified on the command line.
+
+``` yaml $(tag) == 'package-preview-2022-11'
+input-file:
+ - Microsoft.ContainerService/preview/2022-11-02-preview/managedClusters.json
+ - Microsoft.ContainerService/preview/2022-09-02-preview/fleets.json
```
### Tag: package-preview-2022-10-only
diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md
index cb45956bd595..e066018bee8c 100644
--- a/specification/containerservice/resource-manager/readme.python.md
+++ b/specification/containerservice/resource-manager/readme.python.md
@@ -18,6 +18,8 @@ Generate all API versions currently shipped for this package
```yaml $(python)
multiapi: true
batch:
+ - tag: package-2022-11
+ - tag: package-preview-2022-11-only
- tag: package-preview-2022-10-only
- tag: package-2022-09
- tag: package-preview-2022-09
@@ -74,6 +76,26 @@ output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservic
perform-load: false
```
+### Tag: package-2022-11 and python
+
+These settings apply only when `--tag=package-2022-11 --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-11' && $(python)
+namespace: azure.mgmt.containerservice.v2022_11_01
+output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2022_11_01
+```
+
+### Tag: package-preview-2022-11-only and python
+
+These settings apply only when `--tag=package-preview-2022-11-only --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-preview-2022-11-only' && $(python)
+namespace: azure.mgmt.containerservice.v2022_11_02_preview
+output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2022_11_02_preview
+```
+
### Tag: package-preview-2022-10-only and python
These settings apply only when `--tag=package-preview-2022-10-only --python` is specified on the command line.
diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOfflineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOfflineRegion.json
index d49c8b831e10..13531fed7f47 100644
--- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOfflineRegion.json
+++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOfflineRegion.json
@@ -5,11 +5,9 @@
"api-version": "2022-08-15",
"subscriptionId": "subid",
"region": "North Europe",
- "regionParameterForOffline": [
- {
- "region": "North Europe"
- }
- ]
+ "regionParameterForOffline": {
+ "region": "North Europe"
+ }
},
"responses": {
"200": {},
diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOnlineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOnlineRegion.json
index 520c7bce1faf..a14f3b1dde7c 100644
--- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOnlineRegion.json
+++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBDatabaseAccountOnlineRegion.json
@@ -5,11 +5,9 @@
"api-version": "2022-08-15",
"subscriptionId": "subid",
"region": "North Europe",
- "regionParameterForOnline": [
- {
- "region": "North Europe"
- }
- ]
+ "regionParameterForOnline": {
+ "region": "North Europe"
+ }
},
"responses": {
"200": {},
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/settings-createOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/settings-createOrUpdate.json
index c2196c318c6f..a434a06a73cb 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/settings-createOrUpdate.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/settings-createOrUpdate.json
@@ -6,7 +6,7 @@
"setting": {
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
},
@@ -18,7 +18,7 @@
"type": "Microsoft.CostManagement/Settings",
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
},
@@ -29,7 +29,7 @@
"type": "Microsoft.CostManagement/Settings",
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
}
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/settings.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/settings.json
new file mode 100644
index 000000000000..c620f8f9ea4c
--- /dev/null
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/settings.json
@@ -0,0 +1,312 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "CostManagementClient",
+ "version": "2022-10-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": {
+ "/{scope}/providers/Microsoft.CostManagement/settings": {
+ "get": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_List",
+ "description": "List all cost management settings in the requested scope.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingsList": {
+ "$ref": "./examples/settingsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/SettingsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.CostManagement/settings/{type}": {
+ "put": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_CreateOrUpdateByScope",
+ "description": "Create or update a setting within the given scope.",
+ "x-ms-examples": {
+ "CreateOrUpdateSettingByScope": {
+ "$ref": "./examples/settings-createOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "setting",
+ "description": "Setting to be created or updated.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Setting Created.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "200": {
+ "description": "Setting Updated.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_GetByScope",
+ "description": "Get the setting from the given scope by name.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingByScope": {
+ "$ref": "./examples/setting-get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_DeleteByScope",
+ "description": "Delete a setting within the given scope.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingDeleteByScope": {
+ "$ref": "./examples/setting-delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Setting deleted successfully."
+ },
+ "204": {
+ "description": "Setting is already deleted or not found."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Setting": {
+ "description": "Setting definition.",
+ "discriminator": "kind",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "common-types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Specifies the kind of settings.",
+ "enum": [
+ "taginheritance"
+ ],
+ "x-ms-enum": {
+ "name": "SettingsKind",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "TagInheritanceSetting": {
+ "description": "Tag Inheritance Setting definition.",
+ "type": "object",
+ "x-ms-discriminator-value": "taginheritance",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Setting"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TagInheritanceProperties"
+ }
+ }
+ },
+ "SettingsListResult": {
+ "description": "Setting list result. It contains a list of settings.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of settings.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Setting"
+ }
+ }
+ }
+ },
+ "TagInheritanceProperties": {
+ "type": "object",
+ "description": "The properties of the tag inheritance setting.",
+ "required": [
+ "preferContainerTags"
+ ],
+ "properties": {
+ "preferContainerTags": {
+ "description": "When resource has the same tag as subscription or resource group and this property is set to true - the subscription or resource group tag will be applied. If subscription and resource group tags are also the same, subscription tag will be applied.",
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "scopeSettingParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.",
+ "x-ms-parameter-location": "method"
+ },
+ "settingTypeParameter": {
+ "name": "type",
+ "in": "path",
+ "description": "Setting type.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "enum": [
+ "taginheritance"
+ ],
+ "x-ms-enum": {
+ "name": "SettingType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "taginheritance",
+ "description": "This setting applies resource group and subscription tags to usage data of child resources. Inherited tags will be seen within 24 hours for the current month's usage data.",
+ "name": "TagInheritance"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/settings-createOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/settings-createOrUpdate.json
index f5148335a8c4..d992b6c3177b 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/settings-createOrUpdate.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/settings-createOrUpdate.json
@@ -6,7 +6,7 @@
"setting": {
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
},
@@ -18,7 +18,7 @@
"type": "Microsoft.CostManagement/Settings",
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
},
@@ -29,7 +29,7 @@
"type": "Microsoft.CostManagement/Settings",
"kind": "taginheritance",
"properties": {
- "preferContainerTags": true
+ "preferContainerTags": false
}
}
}
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/settings.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/settings.json
new file mode 100644
index 000000000000..b15acbe08d81
--- /dev/null
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/settings.json
@@ -0,0 +1,312 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "CostManagementClient",
+ "version": "2022-10-05-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": {
+ "/{scope}/providers/Microsoft.CostManagement/settings": {
+ "get": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_List",
+ "description": "List all cost management settings in the requested scope.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingsList": {
+ "$ref": "./examples/settingsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/SettingsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.CostManagement/settings/{type}": {
+ "put": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_CreateOrUpdateByScope",
+ "description": "Create or update a setting within the given scope.",
+ "x-ms-examples": {
+ "CreateOrUpdateSettingByScope": {
+ "$ref": "./examples/settings-createOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "setting",
+ "description": "Setting to be created or updated.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Setting Created.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "200": {
+ "description": "Setting Updated.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_GetByScope",
+ "description": "Get the setting from the given scope by name.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingByScope": {
+ "$ref": "./examples/setting-get.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/Setting"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Settings"
+ ],
+ "operationId": "Settings_DeleteByScope",
+ "description": "Delete a setting within the given scope.",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/cost-management/"
+ },
+ "x-ms-examples": {
+ "SettingDeleteByScope": {
+ "$ref": "./examples/setting-delete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/scopeSettingParameter"
+ },
+ {
+ "$ref": "#/parameters/settingTypeParameter"
+ },
+ {
+ "$ref": "common-types.json#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Setting deleted successfully."
+ },
+ "204": {
+ "description": "Setting is already deleted or not found."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "common-types.json#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Setting": {
+ "description": "Setting definition.",
+ "discriminator": "kind",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "common-types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Specifies the kind of settings.",
+ "enum": [
+ "taginheritance"
+ ],
+ "x-ms-enum": {
+ "name": "SettingsKind",
+ "modelAsString": true
+ }
+ }
+ },
+ "required": [
+ "kind"
+ ]
+ },
+ "TagInheritanceSetting": {
+ "description": "Tag Inheritance Setting definition.",
+ "type": "object",
+ "x-ms-discriminator-value": "taginheritance",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Setting"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/TagInheritanceProperties"
+ }
+ }
+ },
+ "SettingsListResult": {
+ "description": "Setting list result. It contains a list of settings.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of settings.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/Setting"
+ }
+ }
+ }
+ },
+ "TagInheritanceProperties": {
+ "type": "object",
+ "description": "The properties of the tag inheritance setting.",
+ "required": [
+ "preferContainerTags"
+ ],
+ "properties": {
+ "preferContainerTags": {
+ "description": "When resource has the same tag as subscription or resource group and this property is set to true - the subscription or resource group tag will be applied. If subscription and resource group tags are also the same, subscription tag will be applied.",
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "scopeSettingParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.",
+ "x-ms-parameter-location": "method"
+ },
+ "settingTypeParameter": {
+ "name": "type",
+ "in": "path",
+ "description": "Setting type.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "enum": [
+ "taginheritance"
+ ],
+ "x-ms-enum": {
+ "name": "SettingType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "taginheritance",
+ "description": "This setting applies resource group and subscription tags to usage data of child resources. Inherited tags will be seen within 24 hours for the current month's usage data.",
+ "name": "TagInheritance"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json
index 19dc4311109e..7acf7d32cf20 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json
@@ -1481,12 +1481,22 @@
"description": "The type of the column in the report.",
"type": "string",
"enum": [
- "Tag",
+ "TagKey",
"Dimension"
],
"x-ms-enum": {
- "name": "ReportConfigColumnType",
- "modelAsString": true
+ "name": "QueryColumnType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "TagKey",
+ "description": "The tag associated with the cost data."
+ },
+ {
+ "value": "Dimension",
+ "description": "The dimension of cost data."
+ }
+ ]
}
},
"ReportConfigComparisonExpression": {
@@ -2742,12 +2752,22 @@
"description": "The type of the column in the export.",
"type": "string",
"enum": [
- "Tag",
+ "TagKey",
"Dimension"
],
"x-ms-enum": {
"name": "QueryColumnType",
- "modelAsString": true
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "TagKey",
+ "description": "The tag associated with the cost data."
+ },
+ {
+ "value": "Dimension",
+ "description": "The dimension of cost data."
+ }
+ ]
}
},
"QueryComparisonExpression": {
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json
index 0f20da030e4e..9c3d9abcecc1 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json
@@ -2,6 +2,7 @@
"parameters": {
"api-version": "2022-10-01",
"name": "monthlyCostByResource",
+ "If-Match": "",
"scheduledAction": {
"kind": "Email",
"properties": {
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json
index 7358f399de5d..7627518c2532 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json
@@ -3,6 +3,7 @@
"api-version": "2022-10-01",
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"name": "monthlyCostByResource",
+ "If-Match": "",
"scheduledAction": {
"kind": "Email",
"properties": {
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json
index 859871813450..3e564257d0d3 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json
@@ -3,6 +3,7 @@
"api-version": "2022-10-01",
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
"name": "dailyAnomalyByResource",
+ "If-Match": "",
"scheduledAction": {
"kind": "InsightAlert",
"properties": {
diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/scheduledActions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/scheduledActions.json
index 1c324820e036..7fd0f2c90d7e 100644
--- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/scheduledActions.json
+++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/scheduledActions.json
@@ -161,6 +161,9 @@
"schema": {
"$ref": "#/definitions/ScheduledAction"
}
+ },
+ {
+ "$ref": "#/parameters/IfMatchOptionalParameter"
}
],
"responses": {
@@ -292,6 +295,9 @@
"schema": {
"$ref": "#/definitions/ScheduledAction"
}
+ },
+ {
+ "$ref": "#/parameters/IfMatchOptionalParameter"
}
],
"responses": {
@@ -649,7 +655,7 @@
"eTag": {
"type": "string",
"readOnly": true,
- "description": "Resource Etag."
+ "description": "Resource Etag. For update calls, eTag is mandatory. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required."
},
"kind": {
"$ref": "#/definitions/ScheduledActionKind",
@@ -913,6 +919,13 @@
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
+ },
+ "IfMatchOptionalParameter": {
+ "name": "If-Match",
+ "in": "header",
+ "required": false,
+ "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.",
+ "type": "string"
}
}
}
diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md
index 24878a10b326..4dddb6da306a 100644
--- a/specification/cost-management/resource-manager/readme.md
+++ b/specification/cost-management/resource-manager/readme.md
@@ -55,6 +55,7 @@ These settings apply only when `--tag=package-preview-2022-10-05` is specified o
```yaml $(tag) == 'package-preview-2022-10-05'
input-file:
- Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json
+ - Microsoft.CostManagement/preview/2022-10-05-preview/settings.json
```
### Tag: package-preview-2022-10
@@ -64,6 +65,7 @@ These settings apply only when `--tag=package-preview-2022-10` is specified on t
``` yaml $(tag) == 'package-preview-2022-10'
input-file:
- Microsoft.CostManagement/preview/2022-10-01-preview/costmanagement.json
+ - Microsoft.CostManagement/preview/2022-10-01-preview/settings.json
```
### Tag: package-preview-2022-08
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json
new file mode 100644
index 000000000000..66c8d0e0bd85
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json
@@ -0,0 +1,6706 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-10-01",
+ "title": "DataBoxManagementClient"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.DataBox/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "This method gets all the operations.",
+ "operationId": "Operations_List",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The supported operations list.",
+ "schema": {
+ "$ref": "#/definitions/OperationList"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OperationsGet": {
+ "$ref": "./examples/OperationsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": {
+ "get": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Lists all the jobs available under the subscription.",
+ "operationId": "Jobs_List",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of jobs available under the subscription.",
+ "schema": {
+ "$ref": "#/definitions/JobResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "JobsList": {
+ "$ref": "./examples/JobsList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate": {
+ "post": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Request to mitigate for a given job",
+ "operationId": "Mitigate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "mitigateJobRequest",
+ "in": "body",
+ "description": "Mitigation Request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MitigateJobRequest"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Mitigate": {
+ "$ref": "./examples/JobMitigate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped": {
+ "post": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Request to mark devices for a given job as shipped",
+ "operationId": "Jobs_MarkDevicesShipped",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "markDevicesShippedRequest",
+ "in": "body",
+ "description": "Mark Devices Shipped Request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MarkDevicesShippedRequest"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "MarkDevicesShipped": {
+ "$ref": "./examples/MarkDevicesShipped.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "This method provides the list of available skus for the given subscription, resource group and location.",
+ "operationId": "Service_ListAvailableSkusByResourceGroup",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "availableSkuRequest",
+ "in": "body",
+ "description": "Filters for showing the available skus.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AvailableSkuRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The list of available skus under Resource group.",
+ "schema": {
+ "$ref": "#/definitions/AvailableSkusResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AvailableSkusPost": {
+ "$ref": "./examples/AvailableSkusPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "[DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer shipping address and provide alternate addresses if any.",
+ "operationId": "Service_ValidateAddress",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "validateAddress",
+ "in": "body",
+ "description": "Shipping address of the customer.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateAddress"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The valid and alternate addresses.",
+ "schema": {
+ "$ref": "#/definitions/AddressValidationOutput"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "deprecated": true,
+ "x-ms-examples": {
+ "ValidateAddressPost": {
+ "$ref": "./examples/ValidateAddressPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "This method does all necessary pre-job creation validation under resource group.",
+ "operationId": "Service_ValidateInputsByResourceGroup",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "validationRequest",
+ "in": "body",
+ "description": "Inputs of the customer.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidationRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The validation status and responses of each validating parameter.",
+ "schema": {
+ "$ref": "#/definitions/ValidationResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ValidateInputsByResourceGroup": {
+ "$ref": "./examples/ValidateInputsByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "This method does all necessary pre-job creation validation under subscription.",
+ "operationId": "Service_ValidateInputs",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "validationRequest",
+ "in": "body",
+ "description": "Inputs of the customer.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidationRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The validation status and responses of each validating parameter.",
+ "schema": {
+ "$ref": "#/definitions/ValidationResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ValidateInputs": {
+ "$ref": "./examples/ValidateInputs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": {
+ "get": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Lists all the jobs available under the given resource group.",
+ "operationId": "Jobs_ListByResourceGroup",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of jobs by resource group.",
+ "schema": {
+ "$ref": "#/definitions/JobResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "JobsListByResourceGroup": {
+ "$ref": "./examples/JobsListByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": {
+ "get": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Gets information about the specified job.",
+ "operationId": "Jobs_Get",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "description": "$expand is supported on details parameter for job, which provides details on the job stages.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Job object.",
+ "schema": {
+ "$ref": "#/definitions/JobResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "JobsGet": {
+ "$ref": "./examples/JobsGet.json"
+ },
+ "JobsGetCmk": {
+ "$ref": "./examples/JobsGetCmk.json"
+ },
+ "JobsGetExport": {
+ "$ref": "./examples/JobsGetExport.json"
+ },
+ "JobsGetCopyStuck": {
+ "$ref": "./examples/JobsGetCopyStuck.json"
+ },
+ "JobsGetWaitingForAction": {
+ "$ref": "./examples/JobsGetWaitingForAction.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.",
+ "operationId": "Jobs_Create",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "jobResource",
+ "in": "body",
+ "description": "Job details from request body.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/JobResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Job object.",
+ "schema": {
+ "$ref": "#/definitions/JobResource"
+ }
+ },
+ "202": {
+ "description": "Accepted request for create Job."
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "JobsCreate": {
+ "$ref": "./examples/JobsCreate.json"
+ },
+ "JobsCreateDevicePassword": {
+ "$ref": "./examples/JobsCreateDevicePassword.json"
+ },
+ "JobsCreateExport": {
+ "$ref": "./examples/JobsCreateExport.json"
+ },
+ "JobsCreateDoubleEncryption": {
+ "$ref": "./examples/JobsCreateDoubleEncryption.json"
+ },
+ "JobsCreateWithUserAssignedIdentity": {
+ "$ref": "./examples/JobsCreateWithUserAssignedIdentity.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Deletes a job.",
+ "operationId": "Jobs_Delete",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Just for swagger we are adding this status code."
+ },
+ "202": {
+ "description": "Accepted request for delete Job.",
+ "headers": {
+ "Location": {
+ "description": "The URI to poll for completion status.",
+ "type": "string"
+ }
+ }
+ },
+ "204": {
+ "description": "Job deleted."
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "JobsDelete": {
+ "$ref": "./examples/JobsDelete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Updates the properties of an existing job.",
+ "operationId": "Jobs_Update",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "If-Match",
+ "in": "header",
+ "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.",
+ "type": "string"
+ },
+ {
+ "name": "jobResourceUpdateParameter",
+ "in": "body",
+ "description": "Job update parameters from request body.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/JobResourceUpdateParameter"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Job object.",
+ "schema": {
+ "$ref": "#/definitions/JobResource"
+ }
+ },
+ "202": {
+ "description": "Accepted request for job updated.",
+ "headers": {
+ "Location": {
+ "description": "The URI to poll for completion status.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "JobsPatch": {
+ "$ref": "./examples/JobsPatch.json"
+ },
+ "JobsPatchCmk": {
+ "$ref": "./examples/JobsPatchCmk.json"
+ },
+ "JobsPatchSystemAssignedToUserAssigned": {
+ "$ref": "./examples/JobsPatchSystemAssignedToUserAssigned.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": {
+ "post": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "Book shipment pick up.",
+ "operationId": "Jobs_BookShipmentPickUp",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "shipmentPickUpRequest",
+ "in": "body",
+ "description": "Details of shipment pick up request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ShipmentPickUpRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Booked shipment pick up successfully.",
+ "schema": {
+ "$ref": "#/definitions/ShipmentPickUpResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "BookShipmentPickupPost": {
+ "$ref": "./examples/BookShipmentPickupPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": {
+ "post": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "CancelJob.",
+ "operationId": "Jobs_Cancel",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "cancellationReason",
+ "in": "body",
+ "description": "Reason for cancellation.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CancellationReason"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Job cancelled."
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "JobsCancelPost": {
+ "$ref": "./examples/JobsCancelPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials": {
+ "post": {
+ "tags": [
+ "Jobs"
+ ],
+ "description": "This method gets the unencrypted secrets related to the job.",
+ "operationId": "Jobs_ListCredentials",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/jobNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of unencrypted credentials of the job.",
+ "schema": {
+ "$ref": "#/definitions/UnencryptedCredentialsList"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "JobsListCredentials": {
+ "$ref": "./examples/JobsListCredentials.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "This API provides configuration details specific to given region/location at Subscription level.",
+ "operationId": "Service_RegionConfiguration",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "regionConfigurationRequest",
+ "in": "body",
+ "description": "Request body to get the configuration for the region.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegionConfigurationRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Region configuration response.",
+ "schema": {
+ "$ref": "#/definitions/RegionConfigurationResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegionConfiguration": {
+ "$ref": "./examples/RegionConfiguration.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration": {
+ "post": {
+ "tags": [
+ "Service"
+ ],
+ "description": "This API provides configuration details specific to given region/location at Resource group level.",
+ "operationId": "Service_RegionConfigurationByResourceGroup",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/locationParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "regionConfigurationRequest",
+ "in": "body",
+ "description": "Request body to get the configuration for the region at resource group level.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RegionConfigurationRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Region configuration response.",
+ "schema": {
+ "$ref": "#/definitions/RegionConfigurationResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing reason for operation failure.",
+ "schema": {
+ "$ref": "#/definitions/ApiError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RegionConfigurationByResourceGroup": {
+ "$ref": "./examples/RegionConfigurationByResourceGroup.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AccountCredentialDetails": {
+ "description": "Credential details of the account.",
+ "type": "object",
+ "properties": {
+ "accountName": {
+ "description": "Name of the account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "dataAccountType": {
+ "description": "Type of the account.",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ }
+ },
+ "accountConnectionString": {
+ "description": "Connection string of the account endpoint to use the account as a storage endpoint on the device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "shareCredentialDetails": {
+ "description": "Per share level unencrypted access credentials.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ShareCredentialDetails"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "AdditionalErrorInfo": {
+ "description": "This class represents additional info which Resource Providers pass when an error occurs.",
+ "properties": {
+ "info": {
+ "description": "Additional information of the type of error.",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AddressValidationOutput": {
+ "description": "Output of the address validation api.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AddressValidationProperties",
+ "description": "The address validation properties.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AddressValidationProperties": {
+ "description": "The address validation output.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "validationStatus": {
+ "description": "The address validation status.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Ambiguous"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AddressValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Address provided is valid."
+ },
+ {
+ "value": "Invalid",
+ "description": "Address provided is invalid or not supported."
+ },
+ {
+ "value": "Ambiguous",
+ "description": "Address provided is ambiguous, please choose one of the alternate addresses returned."
+ }
+ ]
+ }
+ },
+ "alternateAddresses": {
+ "description": "List of alternate addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ShippingAddress"
+ },
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "ValidateAddress"
+ },
+ "ApiError": {
+ "required": [
+ "error"
+ ],
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/ErrorDetail"
+ }
+ }
+ },
+ "ApplianceNetworkConfiguration": {
+ "description": "The Network Adapter configuration of a DataBox.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the network.",
+ "type": "string",
+ "readOnly": true
+ },
+ "macAddress": {
+ "description": "Mac Address.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ArmBaseObject": {
+ "description": "Base class for all objects under resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Id of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AvailableSkuRequest": {
+ "description": "The filters for showing the available skus.",
+ "required": [
+ "transferType",
+ "country",
+ "location"
+ ],
+ "type": "object",
+ "properties": {
+ "transferType": {
+ "description": "Type of the transfer.",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ },
+ "country": {
+ "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01",
+ "type": "string"
+ },
+ "skuNames": {
+ "description": "Sku Names to filter for available skus",
+ "type": "array",
+ "items": {
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "AvailableSkusResult": {
+ "description": "The available skus operation response.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of available skus.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuInformation"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link for the next set of skus.",
+ "type": "string"
+ }
+ }
+ },
+ "AzureFileFilterDetails": {
+ "description": "Filter details to transfer Azure files",
+ "type": "object",
+ "properties": {
+ "filePrefixList": {
+ "description": "Prefix list of the Azure files to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "filePathList": {
+ "description": "List of full path of the files to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileShareList": {
+ "description": "List of file shares to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "BlobFilterDetails": {
+ "description": "Filter details to transfer Azure Blobs",
+ "type": "object",
+ "properties": {
+ "blobPrefixList": {
+ "description": "Prefix list of the Azure blobs to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "blobPathList": {
+ "description": "List of full path of the blobs to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "containerList": {
+ "description": "List of blob containers to be transferred.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "CancellationReason": {
+ "description": "Reason for cancellation.",
+ "required": [
+ "reason"
+ ],
+ "type": "object",
+ "properties": {
+ "reason": {
+ "description": "Reason for cancellation.",
+ "type": "string"
+ }
+ }
+ },
+ "CloudError": {
+ "description": "Provides additional information about an http error response.",
+ "properties": {
+ "additionalInfo": {
+ "description": "Gets or sets additional error info.",
+ "items": {
+ "$ref": "#/definitions/AdditionalErrorInfo"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "code": {
+ "description": "Error code.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Gets or sets details for the error.",
+ "items": {
+ "$ref": "#/definitions/CloudError"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "message": {
+ "description": "The error message parsed from the body of the http error response.",
+ "type": "string"
+ },
+ "target": {
+ "description": "Gets or sets the target of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ContactDetails": {
+ "description": "Contact Details.",
+ "required": [
+ "contactName",
+ "phone",
+ "emailList"
+ ],
+ "type": "object",
+ "properties": {
+ "contactName": {
+ "description": "Contact name of the person.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "Phone number of the contact person.",
+ "type": "string"
+ },
+ "phoneExtension": {
+ "description": "Phone extension number of the contact person.",
+ "type": "string"
+ },
+ "mobile": {
+ "description": "Mobile number of the contact person.",
+ "type": "string"
+ },
+ "emailList": {
+ "description": "List of Email-ids to be notified about job progress.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "notificationPreference": {
+ "description": "Notification preference for a job stage.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NotificationPreference"
+ }
+ }
+ }
+ },
+ "ContactInfo": {
+ "description": "Contact Info.",
+ "required": [
+ "contactName",
+ "phone"
+ ],
+ "type": "object",
+ "properties": {
+ "contactName": {
+ "description": "Contact name of the person.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "phone": {
+ "description": "Phone number of the contact person.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "phoneExtension": {
+ "description": "Phone extension number of the contact person.",
+ "type": "string"
+ },
+ "mobile": {
+ "description": "Mobile number of the contact person.",
+ "type": "string"
+ }
+ }
+ },
+ "CopyLogDetails": {
+ "description": "Details for log generated during copy.",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "properties": {
+ "copyLogDetailsType": {
+ "description": "Indicates the type of job details.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClassDiscriminator",
+ "modelAsExtensible": false,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box orders."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk orders."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy orders."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk orders."
+ }
+ ]
+ }
+ }
+ },
+ "discriminator": "copyLogDetailsType"
+ },
+ "GranularCopyLogDetails": {
+ "description": "Granular Details for log generated during copy.",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "properties": {
+ "copyLogDetailsType": {
+ "description": "Indicates the type of job details.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClassDiscriminator",
+ "modelAsExtensible": false,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box orders."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk orders."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy orders."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk orders."
+ }
+ ]
+ }
+ }
+ },
+ "discriminator": "copyLogDetailsType"
+ },
+ "DataBoxCustomerDiskCopyProgress": {
+ "description": "DataBox CustomerDisk Copy Progress",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyProgress"
+ }
+ ],
+ "properties": {
+ "serialNumber": {
+ "description": "Disk Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "copyStatus": {
+ "description": "The Status of the copy",
+ "enum": [
+ "NotStarted",
+ "InProgress",
+ "Completed",
+ "CompletedWithErrors",
+ "Failed",
+ "NotReturned",
+ "HardwareError",
+ "DeviceFormatted",
+ "DeviceMetadataModified",
+ "StorageAccountNotAccessible",
+ "UnsupportedData",
+ "DriveNotReceived",
+ "UnsupportedDrive",
+ "OtherServiceError",
+ "OtherUserError",
+ "DriveNotDetected",
+ "DriveCorrupted",
+ "MetadataFilesModifiedOrRemoved"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CopyStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotStarted",
+ "description": "Data copy hasn't started yet."
+ },
+ {
+ "value": "InProgress",
+ "description": "Data copy is in progress."
+ },
+ {
+ "value": "Completed",
+ "description": "Data copy completed."
+ },
+ {
+ "value": "CompletedWithErrors",
+ "description": "Data copy completed with errors."
+ },
+ {
+ "value": "Failed",
+ "description": "Data copy failed. No data was copied."
+ },
+ {
+ "value": "NotReturned",
+ "description": "No copy triggered as device was not returned."
+ },
+ {
+ "value": "HardwareError",
+ "description": "The Device has hit hardware issues."
+ },
+ {
+ "value": "DeviceFormatted",
+ "description": "Data copy failed. The Device was formatted by user."
+ },
+ {
+ "value": "DeviceMetadataModified",
+ "description": "Data copy failed. Device metadata was modified by user."
+ },
+ {
+ "value": "StorageAccountNotAccessible",
+ "description": "Data copy failed. Storage Account was not accessible during copy."
+ },
+ {
+ "value": "UnsupportedData",
+ "description": "Data copy failed. The Device data content is not supported."
+ },
+ {
+ "value": "DriveNotReceived",
+ "description": "No copy triggered as device was not received."
+ },
+ {
+ "value": "UnsupportedDrive",
+ "description": "No copy triggered as device type is not supported."
+ },
+ {
+ "value": "OtherServiceError",
+ "description": "Copy failed due to service error."
+ },
+ {
+ "value": "OtherUserError",
+ "description": "Copy failed due to user error."
+ },
+ {
+ "value": "DriveNotDetected",
+ "description": "Copy failed due to disk detection error."
+ },
+ {
+ "value": "DriveCorrupted",
+ "description": "Copy failed due to corrupted drive."
+ },
+ {
+ "value": "MetadataFilesModifiedOrRemoved",
+ "description": "Copy failed due to modified or removed metadata files."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "DeviceErasureDetails": {
+ "description": "Device erasure details with erasure completion status and erasureordestructionlog sas key",
+ "type": "object",
+ "properties": {
+ "deviceErasureStatus": {
+ "description": "Holds the device erasure completion status",
+ "enum": [
+ "None",
+ "InProgress",
+ "Succeeded",
+ "Failed",
+ "Cancelled",
+ "Cancelling",
+ "SucceededWithErrors",
+ "WaitingForCustomerAction",
+ "SucceededWithWarnings",
+ "WaitingForCustomerActionForKek",
+ "WaitingForCustomerActionForCleanUp",
+ "CustomerActionPerformedForCleanUp",
+ "CustomerActionPerformed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StageStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No status available yet."
+ },
+ {
+ "value": "InProgress",
+ "description": "Stage is in progress."
+ },
+ {
+ "value": "Succeeded",
+ "description": "Stage has succeeded."
+ },
+ {
+ "value": "Failed",
+ "description": "Stage has failed."
+ },
+ {
+ "value": "Cancelled",
+ "description": "Stage has been cancelled."
+ },
+ {
+ "value": "Cancelling",
+ "description": "Stage is cancelling."
+ },
+ {
+ "value": "SucceededWithErrors",
+ "description": "Stage has succeeded with errors."
+ },
+ {
+ "value": "WaitingForCustomerAction",
+ "description": "Stage is stuck until customer takes some action."
+ },
+ {
+ "value": "SucceededWithWarnings",
+ "description": "Stage has succeeded with warnings."
+ },
+ {
+ "value": "WaitingForCustomerActionForKek",
+ "description": "Stage is waiting for customer action for kek action items."
+ },
+ {
+ "value": "WaitingForCustomerActionForCleanUp",
+ "description": "Stage is waiting for customer action for clean up."
+ },
+ {
+ "value": "CustomerActionPerformedForCleanUp",
+ "description": "Stage has performed customer action for clean up."
+ },
+ {
+ "value": "CustomerActionPerformed",
+ "description": "Stage has performed customer action for clean up."
+ }
+ ]
+ }
+ },
+ "erasureOrDestructionCertificateSasKey": {
+ "description": "Shared access key to download cleanup or destruction certificate for device",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CopyProgress": {
+ "description": "Copy progress.",
+ "type": "object",
+ "properties": {
+ "storageAccountName": {
+ "description": "Name of the storage account. This will be empty for data account types other than storage account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "transferType": {
+ "description": "Transfer type of data",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ },
+ "dataAccountType": {
+ "description": "Data Account Type.",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ }
+ },
+ "accountId": {
+ "description": "Id of the account where the data needs to be uploaded.",
+ "type": "string",
+ "readOnly": true
+ },
+ "bytesProcessed": {
+ "format": "int64",
+ "description": "To indicate bytes transferred.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalBytesToProcess": {
+ "format": "int64",
+ "description": "Total amount of data to be processed by the job.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "filesProcessed": {
+ "format": "int64",
+ "description": "Number of files processed",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalFilesToProcess": {
+ "format": "int64",
+ "description": "Total files to process",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidFilesProcessed": {
+ "format": "int64",
+ "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidFileBytesUploaded": {
+ "format": "int64",
+ "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "renamedContainerCount": {
+ "format": "int64",
+ "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "filesErroredOut": {
+ "format": "int64",
+ "description": "Number of files which could not be copied",
+ "type": "integer",
+ "readOnly": true
+ },
+ "directoriesErroredOut": {
+ "format": "int64",
+ "description": "To indicate directories errored out in the job.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidDirectoriesProcessed": {
+ "format": "int64",
+ "description": "To indicate directories renamed",
+ "type": "integer",
+ "readOnly": true
+ },
+ "isEnumerationInProgress": {
+ "description": "To indicate if enumeration of data is in progress. \r\nUntil this is true, the TotalBytesToProcess may not be valid.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "GranularCopyProgress": {
+ "description": "Granular Copy progress.",
+ "type": "object",
+ "properties": {
+ "storageAccountName": {
+ "description": "Name of the storage account. This will be empty for data account types other than storage account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "transferType": {
+ "description": "Transfer type of data",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ },
+ "dataAccountType": {
+ "description": "Data Account Type.",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ }
+ },
+ "accountId": {
+ "description": "Id of the account where the data needs to be uploaded.",
+ "type": "string",
+ "readOnly": true
+ },
+ "bytesProcessed": {
+ "format": "int64",
+ "description": "To indicate bytes transferred.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalBytesToProcess": {
+ "format": "int64",
+ "description": "Total amount of data to be processed by the job.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "filesProcessed": {
+ "format": "int64",
+ "description": "Number of files processed",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalFilesToProcess": {
+ "format": "int64",
+ "description": "Total files to process",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidFilesProcessed": {
+ "format": "int64",
+ "description": "Number of files not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidFileBytesUploaded": {
+ "format": "int64",
+ "description": "Total amount of data not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "renamedContainerCount": {
+ "format": "int64",
+ "description": "Number of folders not adhering to azure naming conventions which were processed by automatic renaming",
+ "type": "integer",
+ "readOnly": true
+ },
+ "filesErroredOut": {
+ "format": "int64",
+ "description": "Number of files which could not be copied",
+ "type": "integer",
+ "readOnly": true
+ },
+ "directoriesErroredOut": {
+ "format": "int64",
+ "description": "To indicate directories errored out in the job.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "invalidDirectoriesProcessed": {
+ "format": "int64",
+ "description": "To indicate directories renamed",
+ "type": "integer",
+ "readOnly": true
+ },
+ "isEnumerationInProgress": {
+ "description": "To indicate if enumeration of data is in progress. \r\nUntil this is true, the TotalBytesToProcess may not be valid.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "CreateJobValidations": {
+ "description": "It does all pre-job creation validations.",
+ "required": [
+ "validationCategory",
+ "individualRequestDetails"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationRequest"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "JobCreationValidation"
+ },
+ "CreateOrderLimitForSubscriptionValidationRequest": {
+ "description": "Request to validate create order limit for current subscription.",
+ "required": [
+ "deviceType",
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {
+ "deviceType": {
+ "description": "Device type to be used for the job.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateCreateOrderLimit"
+ },
+ "CreateOrderLimitForSubscriptionValidationResponseProperties": {
+ "description": "Properties of create order limit for subscription validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "status": {
+ "description": "Create order limit validation status.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Validation is successful"
+ },
+ {
+ "value": "Invalid",
+ "description": "Validation is not successful"
+ },
+ {
+ "value": "Skipped",
+ "description": "Validation is skipped"
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateCreateOrderLimit"
+ },
+ "DataBoxCustomerDiskJobDetails": {
+ "description": "Customer disk job details.",
+ "required": [
+ "jobDetailsType",
+ "returnToCustomerPackageDetails"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobDetails"
+ }
+ ],
+ "properties": {
+ "importDiskDetailsCollection": {
+ "description": "Contains the map of disk serial number to the disk details for import jobs.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/ImportDiskDetails"
+ }
+ },
+ "exportDiskDetailsCollection": {
+ "description": "Contains the map of disk serial number to the disk details for export jobs.",
+ "type": "object",
+ "readOnly": true,
+ "additionalProperties": {
+ "$ref": "#/definitions/ExportDiskDetails"
+ }
+ },
+ "copyProgress": {
+ "description": "Copy progress per disk.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxCustomerDiskCopyProgress"
+ },
+ "readOnly": true
+ },
+ "deliverToDcPackageDetails": {
+ "description": "Delivery package shipping details.",
+ "$ref": "#/definitions/PackageCarrierInfo",
+ "readOnly": true
+ },
+ "returnToCustomerPackageDetails": {
+ "description": "Return package shipping details.",
+ "$ref": "#/definitions/PackageCarrierDetails"
+ },
+ "enableManifestBackup": {
+ "description": "Flag to indicate if disk manifest should be backed-up in the Storage Account.",
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxCustomerDisk"
+ },
+ "CustomerDiskJobSecrets": {
+ "description": "The secrets related to customer disk job.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobSecrets"
+ }
+ ],
+ "properties": {
+ "diskSecrets": {
+ "description": "Contains the list of secrets object for that device.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiskSecret"
+ },
+ "readOnly": true
+ },
+ "carrierAccountNumber": {
+ "description": "Carrier Account Number of the customer",
+ "type": "string",
+ "readOnly": true,
+ "x-ms-secret": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxCustomerDisk"
+ },
+ "DataAccountDetails": {
+ "description": "Account details of the data to be transferred",
+ "required": [
+ "dataAccountType"
+ ],
+ "type": "object",
+ "properties": {
+ "dataAccountType": {
+ "description": "Account Type of the data to be transferred.",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ },
+ "default": "StorageAccount"
+ },
+ "sharePassword": {
+ "description": "Password for all the shares to be created on the device. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+",
+ "type": "string",
+ "x-ms-secret": true,
+ "x-ms-mutability": [
+ "create"
+ ]
+ }
+ },
+ "discriminator": "dataAccountType"
+ },
+ "DatacenterAddressInstructionResponse": {
+ "description": "Datacenter instruction for given storage location.",
+ "required": [
+ "datacenterAddressType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatacenterAddressResponse"
+ }
+ ],
+ "properties": {
+ "communicationInstruction": {
+ "description": "Data center communication instruction",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DatacenterAddressInstruction"
+ },
+ "DatacenterAddressLocationResponse": {
+ "description": "Datacenter address for given storage location.",
+ "required": [
+ "datacenterAddressType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DatacenterAddressResponse"
+ }
+ ],
+ "properties": {
+ "contactPersonName": {
+ "description": "Contact person name",
+ "type": "string",
+ "readOnly": true
+ },
+ "company": {
+ "description": "Company name",
+ "type": "string",
+ "readOnly": true
+ },
+ "street1": {
+ "description": "Street address line 1",
+ "type": "string",
+ "readOnly": true
+ },
+ "street2": {
+ "description": "Street address line 2",
+ "type": "string",
+ "readOnly": true
+ },
+ "street3": {
+ "description": "Street address line 3",
+ "type": "string",
+ "readOnly": true
+ },
+ "city": {
+ "description": "City name",
+ "type": "string",
+ "readOnly": true
+ },
+ "state": {
+ "description": "name of the state",
+ "type": "string",
+ "readOnly": true
+ },
+ "zip": {
+ "description": "Zip code",
+ "type": "string",
+ "readOnly": true
+ },
+ "country": {
+ "description": "name of the country",
+ "type": "string",
+ "readOnly": true
+ },
+ "phone": {
+ "description": "Phone number",
+ "type": "string",
+ "readOnly": true
+ },
+ "phoneExtension": {
+ "description": "Phone extension",
+ "type": "string",
+ "readOnly": true
+ },
+ "addressType": {
+ "description": "Address type",
+ "type": "string",
+ "readOnly": true
+ },
+ "additionalShippingInformation": {
+ "description": "Special instruction for shipping",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DatacenterAddressLocation"
+ },
+ "DatacenterAddressRequest": {
+ "description": "Request body to get the datacenter address.",
+ "required": [
+ "storageLocation",
+ "skuName"
+ ],
+ "type": "object",
+ "properties": {
+ "storageLocation": {
+ "description": "Storage location. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01",
+ "type": "string"
+ },
+ "skuName": {
+ "description": "Sku Name for which the data center address requested.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "DatacenterAddressResponse": {
+ "description": "Datacenter address for given storage location.",
+ "required": [
+ "datacenterAddressType"
+ ],
+ "type": "object",
+ "properties": {
+ "datacenterAddressType": {
+ "description": "Data center address type",
+ "enum": [
+ "DatacenterAddressLocation",
+ "DatacenterAddressInstruction"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DatacenterAddressType",
+ "modelAsExtensible": false,
+ "values": [
+ {
+ "value": "DatacenterAddressLocation",
+ "description": "Data center address location."
+ },
+ {
+ "value": "DatacenterAddressInstruction",
+ "description": "Data center address instruction."
+ }
+ ]
+ }
+ },
+ "supportedCarriersForReturnShipment": {
+ "description": "List of supported carriers for return shipment.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "dataCenterAzureLocation": {
+ "description": "Azure Location where the Data Center serves primarily.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "discriminator": "datacenterAddressType"
+ },
+ "DataBoxAccountCopyLogDetails": {
+ "description": "Copy log details for a storage account of a DataBox job",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyLogDetails"
+ }
+ ],
+ "properties": {
+ "accountName": {
+ "description": "Account name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "copyLogLink": {
+ "description": "Link for copy logs.",
+ "type": "string",
+ "readOnly": true
+ },
+ "copyVerboseLogLink": {
+ "description": "Link for copy verbose logs. This will be set only when LogCollectionLevel is set to Verbose.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBox"
+ },
+ "DataBoxCustomerDiskCopyLogDetails": {
+ "description": "Copy Log Details for customer disk",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyLogDetails"
+ }
+ ],
+ "properties": {
+ "serialNumber": {
+ "description": "Disk Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorLogLink": {
+ "description": "Link for copy error logs.",
+ "type": "string",
+ "readOnly": true
+ },
+ "verboseLogLink": {
+ "description": "Link for copy verbose logs.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxCustomerDisk"
+ },
+ "DataBoxDiskCopyLogDetails": {
+ "description": "Copy Log Details for a disk",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyLogDetails"
+ }
+ ],
+ "properties": {
+ "diskSerialNumber": {
+ "description": "Disk Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorLogLink": {
+ "description": "Link for copy error logs.",
+ "type": "string",
+ "readOnly": true
+ },
+ "verboseLogLink": {
+ "description": "Link for copy verbose logs.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxDisk"
+ },
+ "DataBoxDiskGranularCopyLogDetails": {
+ "description": "Granular Copy Log Details for customer disk",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/GranularCopyLogDetails"
+ }
+ ],
+ "properties": {
+ "serialNumber": {
+ "description": "Disk Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "accountId": {
+ "description": "Account id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorLogLink": {
+ "description": "Link for copy error logs.",
+ "type": "string",
+ "readOnly": true
+ },
+ "verboseLogLink": {
+ "description": "Link for copy verbose logs.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxCustomerDisk"
+ },
+ "DataBoxDiskCopyProgress": {
+ "description": "DataBox Disk Copy Progress",
+ "type": "object",
+ "properties": {
+ "serialNumber": {
+ "description": "The serial number of the disk",
+ "type": "string",
+ "readOnly": true
+ },
+ "bytesCopied": {
+ "format": "int64",
+ "description": "Bytes copied during the copy of disk.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "percentComplete": {
+ "format": "int32",
+ "description": "Indicates the percentage completed for the copy of the disk.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The Status of the copy",
+ "enum": [
+ "NotStarted",
+ "InProgress",
+ "Completed",
+ "CompletedWithErrors",
+ "Failed",
+ "NotReturned",
+ "HardwareError",
+ "DeviceFormatted",
+ "DeviceMetadataModified",
+ "StorageAccountNotAccessible",
+ "UnsupportedData",
+ "DriveNotReceived",
+ "UnsupportedDrive",
+ "OtherServiceError",
+ "OtherUserError",
+ "DriveNotDetected",
+ "DriveCorrupted",
+ "MetadataFilesModifiedOrRemoved"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CopyStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotStarted",
+ "description": "Data copy hasn't started yet."
+ },
+ {
+ "value": "InProgress",
+ "description": "Data copy is in progress."
+ },
+ {
+ "value": "Completed",
+ "description": "Data copy completed."
+ },
+ {
+ "value": "CompletedWithErrors",
+ "description": "Data copy completed with errors."
+ },
+ {
+ "value": "Failed",
+ "description": "Data copy failed. No data was copied."
+ },
+ {
+ "value": "NotReturned",
+ "description": "No copy triggered as device was not returned."
+ },
+ {
+ "value": "HardwareError",
+ "description": "The Device has hit hardware issues."
+ },
+ {
+ "value": "DeviceFormatted",
+ "description": "Data copy failed. The Device was formatted by user."
+ },
+ {
+ "value": "DeviceMetadataModified",
+ "description": "Data copy failed. Device metadata was modified by user."
+ },
+ {
+ "value": "StorageAccountNotAccessible",
+ "description": "Data copy failed. Storage Account was not accessible during copy."
+ },
+ {
+ "value": "UnsupportedData",
+ "description": "Data copy failed. The Device data content is not supported."
+ },
+ {
+ "value": "DriveNotReceived",
+ "description": "No copy triggered as device was not received."
+ },
+ {
+ "value": "UnsupportedDrive",
+ "description": "No copy triggered as device type is not supported."
+ },
+ {
+ "value": "OtherServiceError",
+ "description": "Copy failed due to service error."
+ },
+ {
+ "value": "OtherUserError",
+ "description": "Copy failed due to user error."
+ },
+ {
+ "value": "DriveNotDetected",
+ "description": "Copy failed due to disk detection error."
+ },
+ {
+ "value": "DriveCorrupted",
+ "description": "Copy failed due to corrupted drive."
+ },
+ {
+ "value": "MetadataFilesModifiedOrRemoved",
+ "description": "Copy failed due to modified or removed metadata files."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "DataBoxDiskGranularCopyProgress": {
+ "description": "DataBox Disk Granular Copy Progress",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/GranularCopyProgress"
+ }
+ ],
+ "properties": {
+ "serialNumber": {
+ "description": "Disk Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "copyStatus": {
+ "description": "The Status of the copy",
+ "enum": [
+ "NotStarted",
+ "InProgress",
+ "Completed",
+ "CompletedWithErrors",
+ "Failed",
+ "NotReturned",
+ "HardwareError",
+ "DeviceFormatted",
+ "DeviceMetadataModified",
+ "StorageAccountNotAccessible",
+ "UnsupportedData",
+ "DriveNotReceived",
+ "UnsupportedDrive",
+ "OtherServiceError",
+ "OtherUserError",
+ "DriveNotDetected",
+ "DriveCorrupted",
+ "MetadataFilesModifiedOrRemoved"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CopyStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotStarted",
+ "description": "Data copy hasn't started yet."
+ },
+ {
+ "value": "InProgress",
+ "description": "Data copy is in progress."
+ },
+ {
+ "value": "Completed",
+ "description": "Data copy completed."
+ },
+ {
+ "value": "CompletedWithErrors",
+ "description": "Data copy completed with errors."
+ },
+ {
+ "value": "Failed",
+ "description": "Data copy failed. No data was copied."
+ },
+ {
+ "value": "NotReturned",
+ "description": "No copy triggered as device was not returned."
+ },
+ {
+ "value": "HardwareError",
+ "description": "The Device has hit hardware issues."
+ },
+ {
+ "value": "DeviceFormatted",
+ "description": "Data copy failed. The Device was formatted by user."
+ },
+ {
+ "value": "DeviceMetadataModified",
+ "description": "Data copy failed. Device metadata was modified by user."
+ },
+ {
+ "value": "StorageAccountNotAccessible",
+ "description": "Data copy failed. Storage Account was not accessible during copy."
+ },
+ {
+ "value": "UnsupportedData",
+ "description": "Data copy failed. The Device data content is not supported."
+ },
+ {
+ "value": "DriveNotReceived",
+ "description": "No copy triggered as device was not received."
+ },
+ {
+ "value": "UnsupportedDrive",
+ "description": "No copy triggered as device type is not supported."
+ },
+ {
+ "value": "OtherServiceError",
+ "description": "Copy failed due to service error."
+ },
+ {
+ "value": "OtherUserError",
+ "description": "Copy failed due to user error."
+ },
+ {
+ "value": "DriveNotDetected",
+ "description": "Copy failed due to disk detection error."
+ },
+ {
+ "value": "DriveCorrupted",
+ "description": "Copy failed due to corrupted drive."
+ },
+ {
+ "value": "MetadataFilesModifiedOrRemoved",
+ "description": "Copy failed due to modified or removed metadata files."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "DataBoxDiskJobDetails": {
+ "description": "DataBox Disk Job Details.",
+ "required": [
+ "contactDetails",
+ "jobDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobDetails"
+ }
+ ],
+ "properties": {
+ "preferredDisks": {
+ "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "copyProgress": {
+ "description": "Copy progress per disk.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxDiskCopyProgress"
+ },
+ "readOnly": true
+ },
+ "granularCopyProgress": {
+ "description": "Copy progress per disk.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxDiskGranularCopyProgress"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "granularCopyLogDetails": {
+ "description": "Copy progress per disk.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxDiskGranularCopyLogDetails"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "disksAndSizeDetails": {
+ "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "readOnly": true
+ },
+ "passkey": {
+ "description": "User entered passkey for DataBox Disk job.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxDisk"
+ },
+ "DataBoxDiskJobSecrets": {
+ "description": "The secrets related to disk job.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobSecrets"
+ }
+ ],
+ "properties": {
+ "diskSecrets": {
+ "description": "Contains the list of secrets object for that device.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiskSecret"
+ },
+ "readOnly": true
+ },
+ "passKey": {
+ "description": "PassKey for the disk Job.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isPasskeyUserDefined": {
+ "description": "Whether passkey was provided by user.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxDisk"
+ },
+ "DataBoxHeavyAccountCopyLogDetails": {
+ "description": "Copy log details for a storage account for Databox heavy",
+ "required": [
+ "copyLogDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyLogDetails"
+ }
+ ],
+ "properties": {
+ "accountName": {
+ "description": "Account name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "copyLogLink": {
+ "description": "Link for copy logs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "copyVerboseLogLink": {
+ "description": "Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxHeavy"
+ },
+ "DataBoxHeavyJobDetails": {
+ "description": "Databox Heavy Device Job Details",
+ "required": [
+ "contactDetails",
+ "jobDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobDetails"
+ }
+ ],
+ "properties": {
+ "copyProgress": {
+ "description": "Copy progress per account.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CopyProgress"
+ },
+ "readOnly": true
+ },
+ "devicePassword": {
+ "description": "Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxHeavy"
+ },
+ "DataBoxHeavyJobSecrets": {
+ "description": "The secrets related to a databox heavy job.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobSecrets"
+ }
+ ],
+ "properties": {
+ "cabinetPodSecrets": {
+ "description": "Contains the list of secret objects for a databox heavy job.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxHeavySecret"
+ },
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxHeavy"
+ },
+ "DataBoxHeavySecret": {
+ "description": "The secrets related to a databox heavy.",
+ "type": "object",
+ "properties": {
+ "deviceSerialNumber": {
+ "description": "Serial number of the assigned device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "devicePassword": {
+ "description": "Password for out of the box experience on device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "networkConfigurations": {
+ "description": "Network configuration of the appliance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplianceNetworkConfiguration"
+ },
+ "readOnly": true
+ },
+ "encodedValidationCertPubKey": {
+ "description": "The base 64 encoded public key to authenticate with the device",
+ "type": "string",
+ "readOnly": true
+ },
+ "accountCredentialDetails": {
+ "description": "Per account level access credentials.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AccountCredentialDetails"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxJobDetails": {
+ "description": "Databox Job Details",
+ "required": [
+ "contactDetails",
+ "jobDetailsType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobDetails"
+ }
+ ],
+ "properties": {
+ "copyProgress": {
+ "description": "Copy progress per storage account.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CopyProgress"
+ },
+ "readOnly": true
+ },
+ "devicePassword": {
+ "description": "Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\\-$%^!+=;:_()]+",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "DataBox"
+ },
+ "DataboxJobSecrets": {
+ "description": "The secrets related to a databox job.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/JobSecrets"
+ }
+ ],
+ "properties": {
+ "podSecrets": {
+ "description": "Contains the list of secret objects for a job.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxSecret"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "DataBox"
+ },
+ "DataBoxScheduleAvailabilityRequest": {
+ "description": "Request body to get the availability for scheduling data box orders orders.",
+ "required": [
+ "storageLocation",
+ "skuName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScheduleAvailabilityRequest"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "DataBox"
+ },
+ "DataBoxSecret": {
+ "description": "The secrets related to a DataBox.",
+ "type": "object",
+ "properties": {
+ "deviceSerialNumber": {
+ "description": "Serial number of the assigned device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "devicePassword": {
+ "description": "Password for out of the box experience on device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "networkConfigurations": {
+ "description": "Network configuration of the appliance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplianceNetworkConfiguration"
+ },
+ "readOnly": true
+ },
+ "encodedValidationCertPubKey": {
+ "description": "The base 64 encoded public key to authenticate with the device",
+ "type": "string",
+ "readOnly": true
+ },
+ "accountCredentialDetails": {
+ "description": "Per account level access credentials.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AccountCredentialDetails"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "DataExportDetails": {
+ "description": "Details of the data to be used for exporting data from azure.",
+ "required": [
+ "transferConfiguration",
+ "accountDetails"
+ ],
+ "type": "object",
+ "properties": {
+ "transferConfiguration": {
+ "$ref": "#/definitions/TransferConfiguration",
+ "description": "Configuration for the data transfer."
+ },
+ "logCollectionLevel": {
+ "description": "Level of the logs to be collected.",
+ "enum": [
+ "Error",
+ "Verbose"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogCollectionLevel",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Error",
+ "description": "Only Errors will be collected in the logs."
+ },
+ {
+ "value": "Verbose",
+ "description": "Verbose logging (includes Errors, CRC, size information and others)."
+ }
+ ]
+ },
+ "default": "Error"
+ },
+ "accountDetails": {
+ "$ref": "#/definitions/DataAccountDetails",
+ "description": "Account details of the data to be transferred"
+ }
+ }
+ },
+ "DataImportDetails": {
+ "description": "Details of the data to be used for importing data to azure.",
+ "required": [
+ "accountDetails"
+ ],
+ "type": "object",
+ "properties": {
+ "accountDetails": {
+ "$ref": "#/definitions/DataAccountDetails",
+ "description": "Account details of the data to be transferred"
+ },
+ "logCollectionLevel": {
+ "description": "Level of the logs to be collected.",
+ "enum": [
+ "Error",
+ "Verbose"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogCollectionLevel",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Error",
+ "description": "Only Errors will be collected in the logs."
+ },
+ {
+ "value": "Verbose",
+ "description": "Verbose logging (includes Errors, CRC, size information and others)."
+ }
+ ]
+ },
+ "default": "Error"
+ }
+ }
+ },
+ "DataLocationToServiceLocationMap": {
+ "description": "Map of data location to service location",
+ "type": "object",
+ "properties": {
+ "dataLocation": {
+ "description": "Location of the data.",
+ "type": "string",
+ "readOnly": true
+ },
+ "serviceLocation": {
+ "description": "Location of the service.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataTransferDetailsValidationRequest": {
+ "description": "Request to validate export and import data details.",
+ "required": [
+ "deviceType",
+ "transferType",
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {
+ "dataExportDetails": {
+ "description": "List of DataTransfer details to be used to export data from azure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataExportDetails"
+ }
+ },
+ "dataImportDetails": {
+ "description": "List of DataTransfer details to be used to import data to azure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataImportDetails"
+ }
+ },
+ "deviceType": {
+ "description": "Device type.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ },
+ "transferType": {
+ "description": "Type of the transfer.",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateDataTransferDetails"
+ },
+ "DataTransferDetailsValidationResponseProperties": {
+ "description": "Properties of data transfer details validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "status": {
+ "description": "Data transfer details validation status.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Validation is successful"
+ },
+ {
+ "value": "Invalid",
+ "description": "Validation is not successful"
+ },
+ {
+ "value": "Skipped",
+ "description": "Validation is skipped"
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateDataTransferDetails"
+ },
+ "DcAccessSecurityCode": {
+ "description": "Dc access security code",
+ "type": "object",
+ "properties": {
+ "reverseDCAccessCode": {
+ "description": "Reverse Dc access security code.",
+ "type": "string"
+ },
+ "forwardDCAccessCode": {
+ "description": "Forward Dc access security code.",
+ "type": "string"
+ }
+ }
+ },
+ "Details": {
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "DiskScheduleAvailabilityRequest": {
+ "description": "Request body to get the availability for scheduling disk orders.",
+ "required": [
+ "storageLocation",
+ "skuName",
+ "expectedDataSizeInTeraBytes"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScheduleAvailabilityRequest"
+ }
+ ],
+ "properties": {
+ "expectedDataSizeInTeraBytes": {
+ "format": "int32",
+ "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.",
+ "type": "integer"
+ }
+ },
+ "x-ms-discriminator-value": "DataBoxDisk"
+ },
+ "DiskSecret": {
+ "description": "Contains all the secrets of a Disk.",
+ "type": "object",
+ "properties": {
+ "diskSerialNumber": {
+ "description": "Serial number of the assigned disk.",
+ "type": "string",
+ "readOnly": true
+ },
+ "bitLockerKey": {
+ "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "EncryptionPreferences": {
+ "description": "Preferences related to the Encryption.",
+ "type": "object",
+ "properties": {
+ "doubleEncryption": {
+ "description": "Defines secondary layer of software-based encryption enablement.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DoubleEncryption",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Software-based encryption is enabled."
+ },
+ {
+ "value": "Disabled",
+ "description": "Software-based encryption is disabled."
+ }
+ ]
+ },
+ "default": "Disabled"
+ }
+ }
+ },
+ "ErrorDetail": {
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Details"
+ }
+ },
+ "target": {
+ "type": "string"
+ }
+ }
+ },
+ "ExportDiskDetails": {
+ "description": "Export disk details",
+ "type": "object",
+ "properties": {
+ "manifestFile": {
+ "description": "The relative path of the manifest file on the disk.",
+ "type": "string",
+ "readOnly": true
+ },
+ "manifestHash": {
+ "description": "The Base16-encoded MD5 hash of the manifest file on the disk.",
+ "type": "string",
+ "readOnly": true
+ },
+ "backupManifestCloudPath": {
+ "description": "Path to backed up manifest, only returned if enableManifestBackup is true.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "FilterFileDetails": {
+ "description": "Details of the filter files to be used for data transfer.",
+ "required": [
+ "filterFileType",
+ "filterFilePath"
+ ],
+ "type": "object",
+ "properties": {
+ "filterFileType": {
+ "description": "Type of the filter file.",
+ "enum": [
+ "AzureBlob",
+ "AzureFile"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FilterFileType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "AzureBlob",
+ "description": "Filter file is of the type AzureBlob."
+ },
+ {
+ "value": "AzureFile",
+ "description": "Filter file is of the type AzureFiles."
+ }
+ ]
+ }
+ },
+ "filterFilePath": {
+ "description": "Path of the file that contains the details of all items to transfer.",
+ "type": "string"
+ }
+ }
+ },
+ "HeavyScheduleAvailabilityRequest": {
+ "description": "Request body to get the availability for scheduling heavy orders.",
+ "required": [
+ "storageLocation",
+ "skuName"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ScheduleAvailabilityRequest"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "DataBoxHeavy"
+ },
+ "IdentityProperties": {
+ "description": "Managed identity properties.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Managed service identity type.",
+ "type": "string"
+ },
+ "userAssigned": {
+ "$ref": "#/definitions/UserAssignedProperties",
+ "description": "User assigned identity properties."
+ }
+ }
+ },
+ "ImportDiskDetails": {
+ "description": "Import disk details",
+ "required": [
+ "manifestFile",
+ "manifestHash",
+ "bitLockerKey"
+ ],
+ "type": "object",
+ "properties": {
+ "manifestFile": {
+ "description": "The relative path of the manifest file on the disk.",
+ "type": "string"
+ },
+ "manifestHash": {
+ "description": "The Base16-encoded MD5 hash of the manifest file on the disk.",
+ "type": "string"
+ },
+ "bitLockerKey": {
+ "description": "BitLocker key used to encrypt the disk.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "backupManifestCloudPath": {
+ "description": "Path to backed up manifest, only returned if enableManifestBackup is true.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "JobDeliveryInfo": {
+ "description": "Additional delivery info.",
+ "type": "object",
+ "properties": {
+ "scheduledDateTime": {
+ "format": "date-time",
+ "description": "Scheduled date time.",
+ "type": "string"
+ }
+ }
+ },
+ "JobDetails": {
+ "description": "Job details.",
+ "required": [
+ "contactDetails",
+ "jobDetailsType"
+ ],
+ "type": "object",
+ "properties": {
+ "jobStages": {
+ "description": "List of stages that run in the job.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/JobStages"
+ },
+ "readOnly": true
+ },
+ "contactDetails": {
+ "$ref": "#/definitions/ContactDetails",
+ "description": "Contact details for notification and shipping."
+ },
+ "shippingAddress": {
+ "$ref": "#/definitions/ShippingAddress",
+ "description": "Shipping address of the customer."
+ },
+ "deliveryPackage": {
+ "$ref": "#/definitions/PackageShippingDetails",
+ "description": "Delivery package shipping details.",
+ "readOnly": true
+ },
+ "returnPackage": {
+ "$ref": "#/definitions/PackageShippingDetails",
+ "description": "Return package shipping details.",
+ "readOnly": true
+ },
+ "dataImportDetails": {
+ "description": "Details of the data to be imported into azure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataImportDetails"
+ }
+ },
+ "dataExportDetails": {
+ "description": "Details of the data to be exported from azure.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataExportDetails"
+ }
+ },
+ "jobDetailsType": {
+ "description": "Indicates the type of job details.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClassDiscriminator",
+ "modelAsExtensible": false,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box orders."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk orders."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy orders."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk orders."
+ }
+ ]
+ }
+ },
+ "preferences": {
+ "$ref": "#/definitions/Preferences",
+ "description": "Preferences for the order."
+ },
+ "reverseShippingDetails": {
+ "$ref": "#/definitions/ReverseShippingDetails",
+ "description": "Optional Reverse Shipping details for order."
+ },
+ "copyLogDetails": {
+ "description": "List of copy log details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CopyLogDetails"
+ },
+ "readOnly": true
+ },
+ "reverseShipmentLabelSasKey": {
+ "description": "Shared access key to download the return shipment label",
+ "type": "string",
+ "readOnly": true
+ },
+ "chainOfCustodySasKey": {
+ "description": "Shared access key to download the chain of custody logs",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceErasureDetails": {
+ "$ref": "#/definitions/DeviceErasureDetails",
+ "description": "Holds device data erasure details",
+ "readOnly": true
+ },
+ "keyEncryptionKey": {
+ "$ref": "#/definitions/KeyEncryptionKey",
+ "description": "Details about which key encryption type is being used."
+ },
+ "expectedDataSizeInTeraBytes": {
+ "format": "int32",
+ "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.",
+ "type": "integer"
+ },
+ "actions": {
+ "description": "Available actions on the job.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "None",
+ "MoveToCleanUpDevice",
+ "Resume",
+ "Restart",
+ "ReachOutToOperation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomerResolutionCode",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No Resolution Yet"
+ },
+ {
+ "value": "MoveToCleanUpDevice",
+ "description": "Clean the device"
+ },
+ {
+ "value": "Resume",
+ "description": "Resume the job to same stage"
+ },
+ {
+ "description": "Restart whole action.",
+ "value": "Restart"
+ },
+ {
+ "description": "Reach out to operation for further action.",
+ "value": "ReachOutToOperation"
+ }
+ ]
+ }
+ },
+ "readOnly": true
+ },
+ "lastMitigationActionOnJob": {
+ "$ref": "#/definitions/LastMitigationActionOnJob",
+ "description": "Last mitigation action performed on the job.",
+ "readOnly": true
+ },
+ "datacenterAddress": {
+ "$ref": "#/definitions/DatacenterAddressResponse",
+ "description": "Datacenter address to ship to, for the given sku and storage location.",
+ "readOnly": true
+ },
+ "dataCenterCode": {
+ "description": "DataCenter code.",
+ "enum": [
+ "Invalid",
+ "BY2",
+ "BY1",
+ "ORK70",
+ "AM2",
+ "AMS20",
+ "BY21",
+ "BY24",
+ "MWH01",
+ "AMS06",
+ "SSE90",
+ "SYD03",
+ "SYD23",
+ "CBR20",
+ "YTO20",
+ "CWL20",
+ "LON24",
+ "BOM01",
+ "BL20",
+ "BL7",
+ "SEL20",
+ "TYO01",
+ "BN1",
+ "SN5",
+ "CYS04",
+ "TYO22",
+ "YTO21",
+ "YQB20",
+ "FRA22",
+ "MAA01",
+ "CPQ02",
+ "CPQ20",
+ "SIN20",
+ "HKG20",
+ "SG2",
+ "MEL23",
+ "SEL21",
+ "OSA20",
+ "SHA03",
+ "BJB",
+ "JNB22",
+ "JNB21",
+ "MNZ21",
+ "SN8",
+ "AUH20",
+ "ZRH20",
+ "PUS20",
+ "AdHoc",
+ "CH1",
+ "DSM05",
+ "DUB07",
+ "PNQ01",
+ "SVG20",
+ "OSA02",
+ "OSA22",
+ "PAR22",
+ "BN7",
+ "SN6",
+ "BJS20"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataCenterCode",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Invalid"
+ },
+ {
+ "value": "BY2"
+ },
+ {
+ "value": "BY1"
+ },
+ {
+ "value": "ORK70"
+ },
+ {
+ "value": "AM2"
+ },
+ {
+ "value": "AMS20"
+ },
+ {
+ "value": "BY21"
+ },
+ {
+ "value": "BY24"
+ },
+ {
+ "value": "MWH01"
+ },
+ {
+ "value": "AMS06"
+ },
+ {
+ "value": "SSE90"
+ },
+ {
+ "value": "SYD03"
+ },
+ {
+ "value": "SYD23"
+ },
+ {
+ "value": "CBR20"
+ },
+ {
+ "value": "YTO20"
+ },
+ {
+ "value": "CWL20"
+ },
+ {
+ "value": "LON24"
+ },
+ {
+ "value": "BOM01"
+ },
+ {
+ "value": "BL20"
+ },
+ {
+ "value": "BL7"
+ },
+ {
+ "value": "SEL20"
+ },
+ {
+ "value": "TYO01"
+ },
+ {
+ "value": "BN1"
+ },
+ {
+ "value": "SN5"
+ },
+ {
+ "value": "CYS04"
+ },
+ {
+ "value": "TYO22"
+ },
+ {
+ "value": "YTO21"
+ },
+ {
+ "value": "YQB20"
+ },
+ {
+ "value": "FRA22"
+ },
+ {
+ "value": "MAA01"
+ },
+ {
+ "value": "CPQ02"
+ },
+ {
+ "value": "CPQ20"
+ },
+ {
+ "value": "SIN20"
+ },
+ {
+ "value": "HKG20"
+ },
+ {
+ "value": "SG2"
+ },
+ {
+ "value": "MEL23"
+ },
+ {
+ "value": "SEL21"
+ },
+ {
+ "value": "OSA20"
+ },
+ {
+ "value": "SHA03"
+ },
+ {
+ "value": "BJB"
+ },
+ {
+ "value": "JNB22"
+ },
+ {
+ "value": "JNB21"
+ },
+ {
+ "value": "MNZ21"
+ },
+ {
+ "value": "SN8"
+ },
+ {
+ "value": "AUH20"
+ },
+ {
+ "value": "ZRH20"
+ },
+ {
+ "value": "PUS20"
+ },
+ {
+ "value": "AdHoc"
+ },
+ {
+ "value": "CH1"
+ },
+ {
+ "value": "DSM05"
+ },
+ {
+ "value": "DUB07"
+ },
+ {
+ "value": "PNQ01"
+ },
+ {
+ "value": "SVG20"
+ },
+ {
+ "value": "OSA02"
+ },
+ {
+ "value": "OSA22"
+ },
+ {
+ "value": "PAR22"
+ },
+ {
+ "value": "BN7"
+ },
+ {
+ "value": "SN6"
+ },
+ {
+ "value": "BJS20"
+ }
+ ]
+ }
+ }
+ },
+ "discriminator": "jobDetailsType"
+ },
+ "JobProperties": {
+ "description": "Job Properties",
+ "required": [
+ "transferType"
+ ],
+ "type": "object",
+ "properties": {
+ "transferType": {
+ "description": "Type of the data transfer.",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ },
+ "isCancellable": {
+ "description": "Describes whether the job is cancellable or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDeletable": {
+ "description": "Describes whether the job is deletable or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isShippingAddressEditable": {
+ "description": "Describes whether the shipping address is editable or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "reverseShippingDetailsUpdate": {
+ "description": "The Editable status for Reverse Shipping Address and Contact Info",
+ "enum": [
+ "Enabled",
+ "Disabled",
+ "NotSupported"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ReverseShippingDetailsEditStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Reverse shipping details can be edited."
+ },
+ {
+ "value": "Disabled",
+ "description": "Edit is disabled for Reverse shipping details."
+ },
+ {
+ "value": "NotSupported",
+ "description": "Edit is not supported for Reverse shipping details. Either subscription feature is not available or SKU doesn't support this feature."
+ }
+ ]
+ }
+ },
+ "reverseTransportPreferenceUpdate": {
+ "description": "The Editable status for Reverse Transport preferences",
+ "enum": [
+ "Enabled",
+ "Disabled",
+ "NotSupported"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ReverseTransportPreferenceEditStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Enabled",
+ "description": "Reverse Transport Preferences can be edited."
+ },
+ {
+ "value": "Disabled",
+ "description": "Edit is disabled for Reverse Transport Preferences."
+ },
+ {
+ "value": "NotSupported",
+ "description": "Edit is not supported for Reverse Transport Preferences. Either subscription feature is not available or SKU doesn't support this feature."
+ }
+ ]
+ }
+ },
+ "isPrepareToShipEnabled": {
+ "description": "Is Prepare To Ship Enabled on this job",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "status": {
+ "description": "Name of the stage which is in progress.",
+ "enum": [
+ "DeviceOrdered",
+ "DevicePrepared",
+ "Dispatched",
+ "Delivered",
+ "PickedUp",
+ "AtAzureDC",
+ "DataCopy",
+ "Completed",
+ "CompletedWithErrors",
+ "Cancelled",
+ "Failed_IssueReportedAtCustomer",
+ "Failed_IssueDetectedAtAzureDC",
+ "Aborted",
+ "CompletedWithWarnings",
+ "ReadyToDispatchFromAzureDC",
+ "ReadyToReceiveAtAzureDC",
+ "Created",
+ "ShippedToAzureDC",
+ "AwaitingShipmentDetails",
+ "PreparingToShipFromAzureDC",
+ "ShippedToCustomer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StageName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "DeviceOrdered",
+ "description": "An order has been created."
+ },
+ {
+ "value": "DevicePrepared",
+ "description": "A device has been prepared for the order."
+ },
+ {
+ "value": "Dispatched",
+ "description": "Device has been dispatched to the user of the order."
+ },
+ {
+ "value": "Delivered",
+ "description": "Device has been delivered to the user of the order."
+ },
+ {
+ "value": "PickedUp",
+ "description": "Device has been picked up from user and in transit to Azure datacenter."
+ },
+ {
+ "value": "AtAzureDC",
+ "description": "Device has been received at Azure datacenter from the user."
+ },
+ {
+ "value": "DataCopy",
+ "description": "Data copy from the device at Azure datacenter."
+ },
+ {
+ "value": "Completed",
+ "description": "Order has completed."
+ },
+ {
+ "value": "CompletedWithErrors",
+ "description": "Order has completed with errors."
+ },
+ {
+ "value": "Cancelled",
+ "description": "Order has been cancelled."
+ },
+ {
+ "value": "Failed_IssueReportedAtCustomer",
+ "description": "Order has failed due to issue reported by user."
+ },
+ {
+ "value": "Failed_IssueDetectedAtAzureDC",
+ "description": "Order has failed due to issue detected at Azure datacenter."
+ },
+ {
+ "value": "Aborted",
+ "description": "Order has been aborted."
+ },
+ {
+ "value": "CompletedWithWarnings",
+ "description": "Order has completed with warnings."
+ },
+ {
+ "value": "ReadyToDispatchFromAzureDC",
+ "description": "Device is ready to be handed to customer from Azure DC."
+ },
+ {
+ "value": "ReadyToReceiveAtAzureDC",
+ "description": "Device can be dropped off at Azure DC."
+ },
+ {
+ "value": "Created",
+ "description": "Job created by the customer."
+ },
+ {
+ "value": "ShippedToAzureDC",
+ "description": "User shipped the device to AzureDC."
+ },
+ {
+ "value": "AwaitingShipmentDetails",
+ "description": "Awaiting shipment details of device from customer."
+ },
+ {
+ "value": "PreparingToShipFromAzureDC",
+ "description": "Preparing the device to ship to customer."
+ },
+ {
+ "value": "ShippedToCustomer",
+ "description": "Shipped the device to customer."
+ }
+ ]
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "Time at which the job was started in UTC ISO 8601 format.",
+ "type": "string",
+ "readOnly": true
+ },
+ "error": {
+ "$ref": "#/definitions/CloudError",
+ "description": "Top level error for the job.",
+ "readOnly": true
+ },
+ "details": {
+ "$ref": "#/definitions/JobDetails",
+ "description": "Details of a job run. This field will only be sent for expand details filter."
+ },
+ "cancellationReason": {
+ "description": "Reason for cancellation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deliveryType": {
+ "description": "Delivery type of Job.",
+ "enum": [
+ "NonScheduled",
+ "Scheduled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "JobDeliveryType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "NonScheduled",
+ "description": "Non Scheduled job."
+ },
+ {
+ "value": "Scheduled",
+ "description": "Scheduled job."
+ }
+ ]
+ },
+ "default": "NonScheduled"
+ },
+ "deliveryInfo": {
+ "$ref": "#/definitions/JobDeliveryInfo",
+ "description": "Delivery Info of Job."
+ },
+ "isCancellableWithoutFee": {
+ "description": "Flag to indicate cancellation of scheduled job.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "JobResource": {
+ "description": "Job Resource.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/JobProperties",
+ "description": "Properties of a job.",
+ "x-ms-client-flatten": true
+ },
+ "name": {
+ "description": "Name of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Id of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Type of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "readOnly": true
+ }
+ }
+ },
+ "JobResourceList": {
+ "description": "Job Resource Collection",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of job resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/JobResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link for the next set of job resources.",
+ "type": "string"
+ }
+ }
+ },
+ "JobResourceUpdateParameter": {
+ "description": "The JobResourceUpdateParameter.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UpdateJobProperties",
+ "description": "Properties of a job to be updated.",
+ "x-ms-client-flatten": true
+ },
+ "tags": {
+ "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ }
+ }
+ },
+ "JobSecrets": {
+ "description": "The base class for the secrets",
+ "required": [
+ "jobSecretsType"
+ ],
+ "type": "object",
+ "properties": {
+ "jobSecretsType": {
+ "description": "Used to indicate what type of job secrets object.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClassDiscriminator",
+ "modelAsExtensible": false,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box orders."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk orders."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy orders."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk orders."
+ }
+ ]
+ }
+ },
+ "dcAccessSecurityCode": {
+ "$ref": "#/definitions/DcAccessSecurityCode",
+ "description": "Dc Access Security Code for Customer Managed Shipping",
+ "readOnly": true
+ },
+ "error": {
+ "$ref": "#/definitions/CloudError",
+ "description": "Error while fetching the secrets.",
+ "readOnly": true
+ }
+ },
+ "discriminator": "jobSecretsType"
+ },
+ "JobStages": {
+ "description": "Job stages.",
+ "type": "object",
+ "properties": {
+ "stageName": {
+ "description": "Name of the job stage.",
+ "enum": [
+ "DeviceOrdered",
+ "DevicePrepared",
+ "Dispatched",
+ "Delivered",
+ "PickedUp",
+ "AtAzureDC",
+ "DataCopy",
+ "Completed",
+ "CompletedWithErrors",
+ "Cancelled",
+ "Failed_IssueReportedAtCustomer",
+ "Failed_IssueDetectedAtAzureDC",
+ "Aborted",
+ "CompletedWithWarnings",
+ "ReadyToDispatchFromAzureDC",
+ "ReadyToReceiveAtAzureDC",
+ "Created",
+ "ShippedToAzureDC",
+ "AwaitingShipmentDetails",
+ "PreparingToShipFromAzureDC",
+ "ShippedToCustomer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StageName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "DeviceOrdered",
+ "description": "An order has been created."
+ },
+ {
+ "value": "DevicePrepared",
+ "description": "A device has been prepared for the order."
+ },
+ {
+ "value": "Dispatched",
+ "description": "Device has been dispatched to the user of the order."
+ },
+ {
+ "value": "Delivered",
+ "description": "Device has been delivered to the user of the order."
+ },
+ {
+ "value": "PickedUp",
+ "description": "Device has been picked up from user and in transit to Azure datacenter."
+ },
+ {
+ "value": "AtAzureDC",
+ "description": "Device has been received at Azure datacenter from the user."
+ },
+ {
+ "value": "DataCopy",
+ "description": "Data copy from the device at Azure datacenter."
+ },
+ {
+ "value": "Completed",
+ "description": "Order has completed."
+ },
+ {
+ "value": "CompletedWithErrors",
+ "description": "Order has completed with errors."
+ },
+ {
+ "value": "Cancelled",
+ "description": "Order has been cancelled."
+ },
+ {
+ "value": "Failed_IssueReportedAtCustomer",
+ "description": "Order has failed due to issue reported by user."
+ },
+ {
+ "value": "Failed_IssueDetectedAtAzureDC",
+ "description": "Order has failed due to issue detected at Azure datacenter."
+ },
+ {
+ "value": "Aborted",
+ "description": "Order has been aborted."
+ },
+ {
+ "value": "CompletedWithWarnings",
+ "description": "Order has completed with warnings."
+ },
+ {
+ "value": "ReadyToDispatchFromAzureDC",
+ "description": "Device is ready to be handed to customer from Azure DC."
+ },
+ {
+ "value": "ReadyToReceiveAtAzureDC",
+ "description": "Device can be dropped off at Azure DC."
+ },
+ {
+ "value": "Created",
+ "description": "Job created by the customer."
+ },
+ {
+ "value": "ShippedToAzureDC",
+ "description": "User shipped the device to AzureDC."
+ },
+ {
+ "value": "AwaitingShipmentDetails",
+ "description": "Awaiting shipment details of device from customer."
+ },
+ {
+ "value": "PreparingToShipFromAzureDC",
+ "description": "Preparing the device to ship to customer."
+ },
+ {
+ "value": "ShippedToCustomer",
+ "description": "Shipped the device to customer."
+ }
+ ]
+ }
+ },
+ "displayName": {
+ "description": "Display name of the job stage.",
+ "type": "string",
+ "readOnly": true
+ },
+ "stageStatus": {
+ "description": "Status of the job stage.",
+ "enum": [
+ "None",
+ "InProgress",
+ "Succeeded",
+ "Failed",
+ "Cancelled",
+ "Cancelling",
+ "SucceededWithErrors",
+ "WaitingForCustomerAction",
+ "SucceededWithWarnings",
+ "WaitingForCustomerActionForKek",
+ "WaitingForCustomerActionForCleanUp",
+ "CustomerActionPerformedForCleanUp",
+ "CustomerActionPerformed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StageStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No status available yet."
+ },
+ {
+ "value": "InProgress",
+ "description": "Stage is in progress."
+ },
+ {
+ "value": "Succeeded",
+ "description": "Stage has succeeded."
+ },
+ {
+ "value": "Failed",
+ "description": "Stage has failed."
+ },
+ {
+ "value": "Cancelled",
+ "description": "Stage has been cancelled."
+ },
+ {
+ "value": "Cancelling",
+ "description": "Stage is cancelling."
+ },
+ {
+ "value": "SucceededWithErrors",
+ "description": "Stage has succeeded with errors."
+ },
+ {
+ "value": "WaitingForCustomerAction",
+ "description": "Stage is stuck until customer takes some action."
+ },
+ {
+ "value": "SucceededWithWarnings",
+ "description": "Stage has succeeded with warnings."
+ },
+ {
+ "value": "WaitingForCustomerActionForKek",
+ "description": "Stage is waiting for customer action for kek action items."
+ },
+ {
+ "value": "WaitingForCustomerActionForCleanUp",
+ "description": "Stage is waiting for customer action for clean up."
+ },
+ {
+ "value": "CustomerActionPerformedForCleanUp",
+ "description": "Stage has performed customer action for clean up."
+ },
+ {
+ "value": "CustomerActionPerformed",
+ "description": "Stage has performed customer action."
+ }
+ ]
+ }
+ },
+ "stageTime": {
+ "format": "date-time",
+ "description": "Time for the job stage in UTC ISO 8601 format.",
+ "type": "string",
+ "readOnly": true
+ },
+ "jobStageDetails": {
+ "description": "Job Stage Details",
+ "type": "object",
+ "readOnly": true
+ }
+ }
+ },
+ "KeyEncryptionKey": {
+ "description": "Encryption key containing details about key to encrypt different keys.",
+ "required": [
+ "kekType"
+ ],
+ "type": "object",
+ "properties": {
+ "kekType": {
+ "description": "Type of encryption key used for key encryption.",
+ "enum": [
+ "MicrosoftManaged",
+ "CustomerManaged"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KekType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "MicrosoftManaged",
+ "description": "Key encryption key is managed by Microsoft."
+ },
+ {
+ "value": "CustomerManaged",
+ "description": "Key encryption key is managed by the Customer."
+ }
+ ]
+ },
+ "default": "MicrosoftManaged"
+ },
+ "identityProperties": {
+ "$ref": "#/definitions/IdentityProperties",
+ "description": "Managed identity properties used for key encryption."
+ },
+ "kekUrl": {
+ "description": "Key encryption key. It is required in case of Customer managed KekType.",
+ "type": "string"
+ },
+ "kekVaultResourceID": {
+ "description": "Kek vault resource id. It is required in case of Customer managed KekType.",
+ "type": "string"
+ }
+ }
+ },
+ "ManagedDiskDetails": {
+ "description": "Details of the managed disks.",
+ "required": [
+ "resourceGroupId",
+ "stagingStorageAccountId",
+ "dataAccountType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataAccountDetails"
+ }
+ ],
+ "properties": {
+ "resourceGroupId": {
+ "description": "Resource Group Id of the compute disks.",
+ "type": "string"
+ },
+ "stagingStorageAccountId": {
+ "description": "Resource Id of the storage account that can be used to copy the vhd for staging.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "ManagedDisk"
+ },
+ "MarkDevicesShippedRequest": {
+ "description": "The request body to provide the delivery package details of job",
+ "required": [
+ "deliverToDcPackageDetails"
+ ],
+ "type": "object",
+ "properties": {
+ "deliverToDcPackageDetails": {
+ "$ref": "#/definitions/PackageCarrierInfo",
+ "description": "Delivery package details"
+ }
+ }
+ },
+ "LastMitigationActionOnJob": {
+ "description": "Last Mitigation Action Performed On Job",
+ "type": "object",
+ "properties": {
+ "actionDateTimeInUtc": {
+ "format": "date-time",
+ "description": "Action performed date time",
+ "type": "string"
+ },
+ "isPerformedByCustomer": {
+ "description": "Action performed by customer,\r\npossibility is that mitigation might happen by customer or service or by ops",
+ "type": "boolean"
+ },
+ "customerResolution": {
+ "description": "Resolution code provided by customer",
+ "enum": [
+ "None",
+ "MoveToCleanUpDevice",
+ "Resume",
+ "Restart",
+ "ReachOutToOperation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomerResolutionCode",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No Resolution Yet"
+ },
+ {
+ "value": "MoveToCleanUpDevice",
+ "description": "Clean the device"
+ },
+ {
+ "value": "Resume",
+ "description": "Resume the job to same stage"
+ },
+ {
+ "description": "Restart whole action.",
+ "value": "Restart"
+ },
+ {
+ "description": "Reach out to operation for further action.",
+ "value": "ReachOutToOperation"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "MitigateJobRequest": {
+ "description": "The Mitigate Job captured from request body for Mitigate API",
+ "type": "object",
+ "properties": {
+ "customerResolutionCode": {
+ "description": "Resolution code for the job",
+ "enum": [
+ "None",
+ "MoveToCleanUpDevice",
+ "Resume",
+ "Restart",
+ "ReachOutToOperation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomerResolutionCode",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No Resolution Yet"
+ },
+ {
+ "value": "MoveToCleanUpDevice",
+ "description": "Clean the device"
+ },
+ {
+ "value": "Resume",
+ "description": "Resume the job to same stage"
+ },
+ {
+ "description": "Restart whole action.",
+ "value": "Restart"
+ },
+ {
+ "description": "Reach out to operation for further action.",
+ "value": "ReachOutToOperation"
+ }
+ ]
+ }
+ },
+ "serialNumberCustomerResolutionMap": {
+ "description": "Serial number and the customer resolution code corresponding to each serial number",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int32",
+ "description": "Available customer resolution codes on a job",
+ "enum": [
+ "None",
+ "MoveToCleanUpDevice",
+ "Resume",
+ "Restart",
+ "ReachOutToOperation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomerResolutionCode",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "No Resolution Yet"
+ },
+ {
+ "value": "MoveToCleanUpDevice",
+ "description": "Clean the device"
+ },
+ {
+ "value": "Resume",
+ "description": "Resume the job"
+ },
+ {
+ "value": "Restart",
+ "description": "Restart whole action"
+ },
+ {
+ "value": "ReachOutToOperation",
+ "description": "Reach out to operation for further action"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "NotificationPreference": {
+ "description": "Notification preference for a job stage.",
+ "required": [
+ "stageName",
+ "sendNotification"
+ ],
+ "type": "object",
+ "properties": {
+ "stageName": {
+ "description": "Name of the stage.",
+ "enum": [
+ "DevicePrepared",
+ "Dispatched",
+ "Delivered",
+ "PickedUp",
+ "AtAzureDC",
+ "DataCopy",
+ "Created",
+ "ShippedToCustomer"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NotificationStageName",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "DevicePrepared",
+ "description": "Notification at device prepared stage."
+ },
+ {
+ "value": "Dispatched",
+ "description": "Notification at device dispatched stage."
+ },
+ {
+ "value": "Delivered",
+ "description": "Notification at device delivered stage."
+ },
+ {
+ "value": "PickedUp",
+ "description": "Notification at device picked up from user stage."
+ },
+ {
+ "value": "AtAzureDC",
+ "description": "Notification at device received at Azure datacenter stage."
+ },
+ {
+ "value": "DataCopy",
+ "description": "Notification at data copy started stage."
+ },
+ {
+ "value": "Created",
+ "description": "Notification at job created stage."
+ },
+ {
+ "value": "ShippedToCustomer",
+ "description": "Notification at shipped devices to customer stage."
+ }
+ ]
+ }
+ },
+ "sendNotification": {
+ "description": "Notification is required or not.",
+ "type": "boolean",
+ "default": true
+ }
+ }
+ },
+ "Operation": {
+ "description": "Operation entity.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}",
+ "type": "string",
+ "readOnly": true
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay",
+ "description": "Operation display values.",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Operation properties.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "origin": {
+ "description": "Origin of the operation. Can be : user|system|user,system",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "Operation display",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Provider name.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource name.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Localized name of the operation for display purpose.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Localized description of the operation for display purpose.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationList": {
+ "description": "Operation Collection.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link for the next set of operations.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Operation properties.",
+ "type": "object",
+ "properties": {}
+ },
+ "PackageCarrierDetails": {
+ "description": "Package carrier details.",
+ "type": "object",
+ "properties": {
+ "carrierAccountNumber": {
+ "description": "Carrier Account Number of customer for customer disk.",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "carrierName": {
+ "description": "Name of the carrier.",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "Tracking Id of shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "PackageCarrierInfo": {
+ "description": "package carrier info",
+ "type": "object",
+ "properties": {
+ "carrierName": {
+ "description": "Name of the carrier.",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "Tracking Id of shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "PackageShippingDetails": {
+ "description": "package shipping details",
+ "type": "object",
+ "properties": {
+ "trackingUrl": {
+ "description": "Url where shipment can be tracked.",
+ "type": "string",
+ "readOnly": true
+ },
+ "carrierName": {
+ "description": "Name of the carrier.",
+ "type": "string",
+ "readOnly": true
+ },
+ "trackingId": {
+ "description": "Tracking Id of shipment.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Preferences": {
+ "description": "Preferences related to the order",
+ "type": "object",
+ "properties": {
+ "preferredDataCenterRegion": {
+ "description": "Preferred data center region.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "transportPreferences": {
+ "$ref": "#/definitions/TransportPreferences",
+ "description": "Preferences related to the shipment logistics of the sku."
+ },
+ "reverseTransportPreferences": {
+ "$ref": "#/definitions/TransportPreferences",
+ "description": "Optional Preferences related to the reverse shipment logistics of the sku."
+ },
+ "encryptionPreferences": {
+ "$ref": "#/definitions/EncryptionPreferences",
+ "description": "Preferences related to the Encryption."
+ },
+ "storageAccountAccessTierPreferences": {
+ "description": "Preferences related to the Access Tier of storage accounts.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "Archive"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "StorageAccountAccessTier",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Archive",
+ "description": "Archive Access Tier shares requested by the customer."
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "PreferencesValidationRequest": {
+ "description": "Request to validate preference of transport and data center.",
+ "required": [
+ "deviceType",
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {
+ "preference": {
+ "description": "Preference of transport and data center.",
+ "$ref": "#/definitions/Preferences"
+ },
+ "deviceType": {
+ "description": "Device type to be used for the job.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidatePreferences"
+ },
+ "PreferencesValidationResponseProperties": {
+ "description": "Properties of data center and transport preference validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "status": {
+ "description": "Validation status of requested data center and transport.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Validation is successful"
+ },
+ {
+ "value": "Invalid",
+ "description": "Validation is not successful"
+ },
+ {
+ "value": "Skipped",
+ "description": "Validation is skipped"
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidatePreferences"
+ },
+ "RegionConfigurationRequest": {
+ "description": "Request body to get the configuration for the region.",
+ "type": "object",
+ "properties": {
+ "scheduleAvailabilityRequest": {
+ "$ref": "#/definitions/ScheduleAvailabilityRequest",
+ "description": "Request body to get the availability for scheduling orders."
+ },
+ "transportAvailabilityRequest": {
+ "$ref": "#/definitions/TransportAvailabilityRequest",
+ "description": "Request body to get the transport availability for given sku."
+ },
+ "datacenterAddressRequest": {
+ "$ref": "#/definitions/DatacenterAddressRequest",
+ "description": "Request body to get the datacenter address for given sku."
+ }
+ }
+ },
+ "RegionConfigurationResponse": {
+ "description": "Configuration response specific to a region.",
+ "type": "object",
+ "properties": {
+ "scheduleAvailabilityResponse": {
+ "$ref": "#/definitions/ScheduleAvailabilityResponse",
+ "description": "Schedule availability for given sku in a region.",
+ "readOnly": true
+ },
+ "transportAvailabilityResponse": {
+ "$ref": "#/definitions/TransportAvailabilityResponse",
+ "description": "Transport options available for given sku in a region.",
+ "readOnly": true
+ },
+ "datacenterAddressResponse": {
+ "$ref": "#/definitions/DatacenterAddressResponse",
+ "description": "Datacenter address for given sku in a region.",
+ "readOnly": true
+ }
+ }
+ },
+ "Resource": {
+ "description": "Model of the Resource.",
+ "required": [
+ "location",
+ "sku"
+ ],
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The sku type."
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ResourceIdentity": {
+ "description": "Msi identity details of the resource",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Identity type",
+ "type": "string",
+ "default": "None"
+ },
+ "principalId": {
+ "description": "Service Principal Id backing the Msi",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "description": "Home Tenant Id",
+ "type": "string",
+ "readOnly": true
+ },
+ "userAssignedIdentities": {
+ "description": "User Assigned Identities",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserAssignedIdentity"
+ }
+ }
+ }
+ },
+ "ReverseShippingDetails": {
+ "description": "Reverse Shipping Address and contact details for a job.",
+ "type": "object",
+ "properties": {
+ "contactDetails": {
+ "$ref": "#/definitions/ContactInfo"
+ },
+ "shippingAddress": {
+ "$ref": "#/definitions/ShippingAddress"
+ },
+ "isUpdated": {
+ "description": "A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared.\r\nRead only field",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "ScheduleAvailabilityRequest": {
+ "description": "Request body to get the availability for scheduling orders.",
+ "required": [
+ "storageLocation",
+ "skuName"
+ ],
+ "type": "object",
+ "properties": {
+ "storageLocation": {
+ "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01",
+ "type": "string"
+ },
+ "skuName": {
+ "description": "Sku Name for which the order is to be scheduled.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ },
+ "country": {
+ "description": "Country in which storage location should be supported.",
+ "type": "string"
+ }
+ },
+ "discriminator": "skuName"
+ },
+ "ScheduleAvailabilityResponse": {
+ "description": "Schedule availability for given sku in a region.",
+ "type": "object",
+ "properties": {
+ "availableDates": {
+ "description": "List of dates available to schedule",
+ "type": "array",
+ "items": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ShareCredentialDetails": {
+ "description": "Credential details of the shares in account.",
+ "type": "object",
+ "properties": {
+ "shareName": {
+ "description": "Name of the share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "shareType": {
+ "description": "Type of the share.",
+ "enum": [
+ "UnknownType",
+ "HCS",
+ "BlockBlob",
+ "PageBlob",
+ "AzureFile",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ShareDestinationFormatType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "UnknownType",
+ "description": "Unknown format."
+ },
+ {
+ "value": "HCS",
+ "description": "Storsimple data format."
+ },
+ {
+ "value": "BlockBlob",
+ "description": "Azure storage block blob format."
+ },
+ {
+ "value": "PageBlob",
+ "description": "Azure storage page blob format."
+ },
+ {
+ "value": "AzureFile",
+ "description": "Azure storage file format."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Compute Disk."
+ }
+ ]
+ }
+ },
+ "userName": {
+ "description": "User name for the share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "password": {
+ "description": "Password for the share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "supportedAccessProtocols": {
+ "description": "Access protocols supported on the device.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "SMB",
+ "NFS"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccessProtocol",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "SMB",
+ "description": "Server Message Block protocol(SMB)."
+ },
+ {
+ "value": "NFS",
+ "description": "Network File System protocol(NFS)."
+ }
+ ]
+ }
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ShipmentPickUpRequest": {
+ "description": "Shipment pick up request details.",
+ "required": [
+ "startTime",
+ "endTime",
+ "shipmentLocation"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.",
+ "type": "string"
+ },
+ "shipmentLocation": {
+ "description": "Shipment Location in the pickup place. Eg.front desk",
+ "type": "string"
+ }
+ }
+ },
+ "ShipmentPickUpResponse": {
+ "description": "Shipment pick up response.",
+ "type": "object",
+ "properties": {
+ "confirmationNumber": {
+ "description": "Confirmation number for the pick up request.",
+ "type": "string",
+ "readOnly": true
+ },
+ "readyByTime": {
+ "format": "date-time",
+ "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ShippingAddress": {
+ "description": "Shipping address where customer wishes to receive the device.",
+ "required": [
+ "streetAddress1",
+ "country"
+ ],
+ "type": "object",
+ "properties": {
+ "streetAddress1": {
+ "description": "Street Address line 1.",
+ "type": "string"
+ },
+ "streetAddress2": {
+ "description": "Street Address line 2.",
+ "type": "string"
+ },
+ "streetAddress3": {
+ "description": "Street Address line 3.",
+ "type": "string"
+ },
+ "city": {
+ "description": "Name of the City.",
+ "type": "string"
+ },
+ "stateOrProvince": {
+ "description": "Name of the State or Province.",
+ "type": "string"
+ },
+ "country": {
+ "description": "Name of the Country.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Postal code.",
+ "type": "string"
+ },
+ "zipExtendedCode": {
+ "description": "Extended Zip Code.",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "Name of the company.",
+ "type": "string"
+ },
+ "addressType": {
+ "description": "Type of address.",
+ "enum": [
+ "None",
+ "Residential",
+ "Commercial"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AddressType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "Address type not known."
+ },
+ {
+ "value": "Residential",
+ "description": "Residential Address."
+ },
+ {
+ "value": "Commercial",
+ "description": "Commercial Address."
+ }
+ ]
+ },
+ "default": "None"
+ }
+ }
+ },
+ "Sku": {
+ "description": "The Sku.",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The sku name.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ },
+ "displayName": {
+ "description": "The display name of the sku.",
+ "type": "string"
+ },
+ "family": {
+ "description": "The sku family.",
+ "type": "string"
+ }
+ }
+ },
+ "SkuAvailabilityValidationRequest": {
+ "description": "Request to validate sku availability.",
+ "required": [
+ "deviceType",
+ "transferType",
+ "country",
+ "location",
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {
+ "deviceType": {
+ "description": "Device type to be used for the job.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ },
+ "transferType": {
+ "description": "Type of the transfer.",
+ "enum": [
+ "ImportToAzure",
+ "ExportFromAzure"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransferType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ImportToAzure",
+ "description": "Import data to azure."
+ },
+ {
+ "value": "ExportFromAzure",
+ "description": "Export data from azure."
+ }
+ ]
+ }
+ },
+ "country": {
+ "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "ValidateSkuAvailability"
+ },
+ "SkuAvailabilityValidationResponseProperties": {
+ "description": "Properties of sku availability validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "status": {
+ "description": "Sku availability validation status.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Validation is successful"
+ },
+ {
+ "value": "Invalid",
+ "description": "Validation is not successful"
+ },
+ {
+ "value": "Skipped",
+ "description": "Validation is skipped"
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateSkuAvailability"
+ },
+ "SkuCapacity": {
+ "description": "Capacity of the sku.",
+ "type": "object",
+ "properties": {
+ "usable": {
+ "description": "Usable capacity in TB.",
+ "type": "string",
+ "readOnly": true
+ },
+ "maximum": {
+ "description": "Maximum capacity in TB.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuCost": {
+ "description": "Describes metadata for retrieving price info.",
+ "type": "object",
+ "properties": {
+ "meterId": {
+ "description": "Meter id of the Sku.",
+ "type": "string",
+ "readOnly": true
+ },
+ "meterType": {
+ "description": "The type of the meter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "multiplier": {
+ "format": "double",
+ "description": "Multiplier specifies the region specific value to be multiplied with 1$ guid. Eg: Our new regions will be using 1$ shipping guid with appropriate multiplier specific to region.",
+ "type": "number",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuInformation": {
+ "description": "Information of the sku.",
+ "type": "object",
+ "properties": {
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The Sku.",
+ "readOnly": true
+ },
+ "enabled": {
+ "description": "The sku is enabled or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/SkuProperties",
+ "description": "Properties of the sku.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SkuProperties": {
+ "description": "Properties of the sku.",
+ "type": "object",
+ "properties": {
+ "dataLocationToServiceLocationMap": {
+ "description": "The map of data location to service location.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataLocationToServiceLocationMap"
+ },
+ "readOnly": true
+ },
+ "capacity": {
+ "$ref": "#/definitions/SkuCapacity",
+ "description": "Capacity of the Sku.",
+ "readOnly": true
+ },
+ "costs": {
+ "description": "Cost of the Sku.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCost"
+ },
+ "readOnly": true
+ },
+ "apiVersions": {
+ "description": "Api versions that support this Sku.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "disabledReason": {
+ "description": "Reason why the Sku is disabled.",
+ "enum": [
+ "None",
+ "Country",
+ "Region",
+ "Feature",
+ "OfferType",
+ "NoSubscriptionInfo"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuDisabledReason",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "SKU is not disabled."
+ },
+ {
+ "value": "Country",
+ "description": "SKU is not available in the requested country."
+ },
+ {
+ "value": "Region",
+ "description": "SKU is not available to push data to the requested Azure region."
+ },
+ {
+ "value": "Feature",
+ "description": "Required features are not enabled for the SKU."
+ },
+ {
+ "value": "OfferType",
+ "description": "Subscription does not have required offer types for the SKU."
+ },
+ {
+ "value": "NoSubscriptionInfo",
+ "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification."
+ }
+ ]
+ }
+ },
+ "disabledReasonMessage": {
+ "description": "Message for why the Sku is disabled.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requiredFeature": {
+ "description": "Required feature to access the sku.",
+ "type": "string",
+ "readOnly": true
+ },
+ "countriesWithinCommerceBoundary": {
+ "description": "List of all the Countries in the SKU specific commerce boundary",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountDetails": {
+ "description": "Details for the storage account.",
+ "required": [
+ "storageAccountId",
+ "dataAccountType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataAccountDetails"
+ }
+ ],
+ "properties": {
+ "storageAccountId": {
+ "description": "Storage Account Resource Id.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "StorageAccount"
+ },
+ "SubscriptionIsAllowedToCreateJobValidationRequest": {
+ "description": "Request to validate subscription permission to create jobs.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {},
+ "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob"
+ },
+ "SubscriptionIsAllowedToCreateJobValidationResponseProperties": {
+ "description": "Properties of subscription permission to create job validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputResponse"
+ }
+ ],
+ "properties": {
+ "status": {
+ "description": "Validation status of subscription permission to create job.",
+ "enum": [
+ "Valid",
+ "Invalid",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "Valid",
+ "description": "Validation is successful"
+ },
+ {
+ "value": "Invalid",
+ "description": "Validation is not successful"
+ },
+ {
+ "value": "Skipped",
+ "description": "Validation is skipped"
+ }
+ ]
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ValidateSubscriptionIsAllowedToCreateJob"
+ },
+ "systemData": {
+ "description": "Provides details about resource creation and update time",
+ "type": "object",
+ "properties": {
+ "createdBy": {
+ "description": "A string identifier for the identity that created the resource",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdByType": {
+ "description": "The type of identity that created the resource: user, application, managedIdentity",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedBy": {
+ "description": "A string identifier for the identity that last modified the resource",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedByType": {
+ "description": "The type of identity that last modified the resource: user, application, managedIdentity",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastModifiedAt": {
+ "format": "date-time",
+ "description": "The timestamp of resource last modification (UTC)",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TransferAllDetails": {
+ "description": "Details to transfer all data.",
+ "required": [
+ "dataAccountType"
+ ],
+ "type": "object",
+ "properties": {
+ "dataAccountType": {
+ "description": "Type of the account of data",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ },
+ "default": "StorageAccount"
+ },
+ "transferAllBlobs": {
+ "description": "To indicate if all Azure blobs have to be transferred",
+ "type": "boolean"
+ },
+ "transferAllFiles": {
+ "description": "To indicate if all Azure Files have to be transferred",
+ "type": "boolean"
+ }
+ }
+ },
+ "TransferConfiguration": {
+ "description": "Configuration for defining the transfer of data.",
+ "required": [
+ "transferConfigurationType"
+ ],
+ "type": "object",
+ "properties": {
+ "transferConfigurationType": {
+ "description": "Type of the configuration for transfer.",
+ "enum": [
+ "TransferAll",
+ "TransferUsingFilter"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransferConfigurationType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "TransferAll",
+ "description": "Transfer all the data."
+ },
+ {
+ "value": "TransferUsingFilter",
+ "description": "Transfer using filter."
+ }
+ ]
+ }
+ },
+ "transferFilterDetails": {
+ "description": "Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter.",
+ "type": "object",
+ "properties": {
+ "include": {
+ "description": "Details of the filtering the transfer of data.",
+ "$ref": "#/definitions/TransferFilterDetails"
+ }
+ }
+ },
+ "transferAllDetails": {
+ "description": "Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll",
+ "type": "object",
+ "properties": {
+ "include": {
+ "description": "Details to transfer all data.",
+ "$ref": "#/definitions/TransferAllDetails"
+ }
+ }
+ }
+ }
+ },
+ "TransferFilterDetails": {
+ "description": "Details of the filtering the transfer of data.",
+ "required": [
+ "dataAccountType"
+ ],
+ "type": "object",
+ "properties": {
+ "dataAccountType": {
+ "description": "Type of the account of data.",
+ "enum": [
+ "StorageAccount",
+ "ManagedDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataAccountType",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "StorageAccount",
+ "description": "Storage Accounts ."
+ },
+ {
+ "value": "ManagedDisk",
+ "description": "Azure Managed disk storage."
+ }
+ ]
+ },
+ "default": "StorageAccount"
+ },
+ "blobFilterDetails": {
+ "$ref": "#/definitions/BlobFilterDetails",
+ "description": "Filter details to transfer blobs."
+ },
+ "azureFileFilterDetails": {
+ "$ref": "#/definitions/AzureFileFilterDetails",
+ "description": "Filter details to transfer Azure files."
+ },
+ "filterFileDetails": {
+ "description": "Details of the filter files to be used for data transfer.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FilterFileDetails"
+ }
+ }
+ }
+ },
+ "TransportAvailabilityDetails": {
+ "description": "Transport options availability details for given region.",
+ "type": "object",
+ "properties": {
+ "shipmentType": {
+ "description": "Transport Shipment Type supported for given region.",
+ "enum": [
+ "CustomerManaged",
+ "MicrosoftManaged"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "TransportShipmentTypes",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "CustomerManaged",
+ "description": "Shipment Logistics is handled by the customer."
+ },
+ {
+ "value": "MicrosoftManaged",
+ "description": "Shipment Logistics is handled by Microsoft."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "TransportAvailabilityRequest": {
+ "description": "Request body to get the transport availability for given sku.",
+ "type": "object",
+ "properties": {
+ "skuName": {
+ "description": "Type of the device.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "TransportAvailabilityResponse": {
+ "description": "Transport options available for given sku in a region.",
+ "type": "object",
+ "properties": {
+ "transportAvailabilityDetails": {
+ "description": "List of transport availability details for given region",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TransportAvailabilityDetails"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "TransportPreferences": {
+ "description": "Preferences related to the shipment logistics of the sku",
+ "required": [
+ "preferredShipmentType"
+ ],
+ "type": "object",
+ "properties": {
+ "preferredShipmentType": {
+ "description": "Indicates Shipment Logistics type that the customer preferred.",
+ "enum": [
+ "CustomerManaged",
+ "MicrosoftManaged"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TransportShipmentTypes",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "CustomerManaged",
+ "description": "Shipment Logistics is handled by the customer."
+ },
+ {
+ "value": "MicrosoftManaged",
+ "description": "Shipment Logistics is handled by Microsoft."
+ }
+ ]
+ }
+ },
+ "isUpdated": {
+ "description": "Read only property which indicates whether transport preferences has been updated or not after device is prepared.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "UnencryptedCredentials": {
+ "description": "Unencrypted credentials for accessing device.",
+ "type": "object",
+ "properties": {
+ "jobName": {
+ "description": "Name of the job.",
+ "type": "string",
+ "readOnly": true
+ },
+ "jobSecrets": {
+ "$ref": "#/definitions/JobSecrets",
+ "description": "Secrets related to this job.",
+ "readOnly": true
+ }
+ }
+ },
+ "UnencryptedCredentialsList": {
+ "description": "List of unencrypted credentials for accessing device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of unencrypted credentials.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UnencryptedCredentials"
+ }
+ },
+ "nextLink": {
+ "description": "Link for the next set of unencrypted credentials.",
+ "type": "string"
+ }
+ }
+ },
+ "UpdateJobDetails": {
+ "description": "Job details for update.",
+ "type": "object",
+ "properties": {
+ "contactDetails": {
+ "$ref": "#/definitions/ContactDetails",
+ "description": "Contact details for notification and shipping."
+ },
+ "shippingAddress": {
+ "$ref": "#/definitions/ShippingAddress",
+ "description": "Shipping address of the customer."
+ },
+ "reverseShippingDetails": {
+ "$ref": "#/definitions/ReverseShippingDetails"
+ },
+ "preferences": {
+ "$ref": "#/definitions/Preferences"
+ },
+ "keyEncryptionKey": {
+ "$ref": "#/definitions/KeyEncryptionKey",
+ "description": "Key encryption key for the job."
+ },
+ "returnToCustomerPackageDetails": {
+ "$ref": "#/definitions/PackageCarrierDetails",
+ "description": "Return package details of job."
+ }
+ }
+ },
+ "UpdateJobProperties": {
+ "description": "Job Properties for update",
+ "type": "object",
+ "properties": {
+ "details": {
+ "$ref": "#/definitions/UpdateJobDetails",
+ "description": "Details of a job to be updated."
+ }
+ }
+ },
+ "UserAssignedIdentity": {
+ "description": "Class defining User assigned identity details.",
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "The principal id of user assigned identity.",
+ "type": "string",
+ "readOnly": true
+ },
+ "clientId": {
+ "description": "The client id of user assigned identity.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UserAssignedProperties": {
+ "description": "User assigned identity properties.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "Arm resource id for user assigned identity to be used to fetch MSI token.",
+ "type": "string"
+ }
+ }
+ },
+ "ValidateAddress": {
+ "description": "The requirements to validate customer address where the device needs to be shipped.",
+ "required": [
+ "shippingAddress",
+ "deviceType",
+ "validationType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ ],
+ "properties": {
+ "shippingAddress": {
+ "$ref": "#/definitions/ShippingAddress",
+ "description": "Shipping address of the customer."
+ },
+ "deviceType": {
+ "description": "Device type to be used for the job.",
+ "enum": [
+ "DataBox",
+ "DataBoxDisk",
+ "DataBoxHeavy",
+ "DataBoxCustomerDisk"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "DataBox",
+ "description": "Data Box."
+ },
+ {
+ "value": "DataBoxDisk",
+ "description": "Data Box Disk."
+ },
+ {
+ "value": "DataBoxHeavy",
+ "description": "Data Box Heavy."
+ },
+ {
+ "value": "DataBoxCustomerDisk",
+ "description": "Data Box Customer Disk."
+ }
+ ]
+ }
+ },
+ "transportPreferences": {
+ "$ref": "#/definitions/TransportPreferences",
+ "description": "Preferences related to the shipment logistics of the sku."
+ }
+ },
+ "x-ms-discriminator-value": "ValidateAddress"
+ },
+ "ValidationInputRequest": {
+ "description": "Minimum fields that must be present in any type of validation request.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "properties": {
+ "validationType": {
+ "description": "Identifies the type of validation request.",
+ "enum": [
+ "ValidateAddress",
+ "ValidateSubscriptionIsAllowedToCreateJob",
+ "ValidatePreferences",
+ "ValidateCreateOrderLimit",
+ "ValidateSkuAvailability",
+ "ValidateDataTransferDetails"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationInputDiscriminator",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ValidateAddress",
+ "description": "Identify request and response of address validation."
+ },
+ {
+ "value": "ValidateSubscriptionIsAllowedToCreateJob",
+ "description": "Identify request and response for validation of subscription permission to create job."
+ },
+ {
+ "value": "ValidatePreferences",
+ "description": "Identify request and response of preference validation."
+ },
+ {
+ "value": "ValidateCreateOrderLimit",
+ "description": "Identify request and response of create order limit for subscription validation."
+ },
+ {
+ "value": "ValidateSkuAvailability",
+ "description": "Identify request and response of active job limit for sku availability."
+ },
+ {
+ "value": "ValidateDataTransferDetails",
+ "description": "Identify request and response of data transfer details validation."
+ }
+ ]
+ }
+ }
+ },
+ "discriminator": "validationType"
+ },
+ "ValidationInputResponse": {
+ "description": "Minimum properties that should be present in each individual validation response.",
+ "required": [
+ "validationType"
+ ],
+ "type": "object",
+ "properties": {
+ "validationType": {
+ "description": "Identifies the type of validation response.",
+ "enum": [
+ "ValidateAddress",
+ "ValidateSubscriptionIsAllowedToCreateJob",
+ "ValidatePreferences",
+ "ValidateCreateOrderLimit",
+ "ValidateSkuAvailability",
+ "ValidateDataTransferDetails"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationInputDiscriminator",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "ValidateAddress",
+ "description": "Identify request and response of address validation."
+ },
+ {
+ "value": "ValidateSubscriptionIsAllowedToCreateJob",
+ "description": "Identify request and response for validation of subscription permission to create job."
+ },
+ {
+ "value": "ValidatePreferences",
+ "description": "Identify request and response of preference validation."
+ },
+ {
+ "value": "ValidateCreateOrderLimit",
+ "description": "Identify request and response of create order limit for subscription validation."
+ },
+ {
+ "value": "ValidateSkuAvailability",
+ "description": "Identify request and response of active job limit for sku availability."
+ },
+ {
+ "value": "ValidateDataTransferDetails",
+ "description": "Identify request and response of data transfer details validation."
+ }
+ ]
+ }
+ },
+ "error": {
+ "$ref": "#/definitions/CloudError",
+ "description": "Error code and message of validation response.",
+ "readOnly": true
+ }
+ },
+ "discriminator": "validationType"
+ },
+ "ValidationRequest": {
+ "description": "Minimum request requirement of any validation category.",
+ "required": [
+ "validationCategory",
+ "individualRequestDetails"
+ ],
+ "type": "object",
+ "properties": {
+ "validationCategory": {
+ "description": "Identify the nature of validation.",
+ "enum": [
+ "JobCreationValidation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationCategory",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "JobCreationValidation",
+ "description": "Identify request of pre-job creation validations."
+ }
+ ]
+ }
+ },
+ "individualRequestDetails": {
+ "description": "List of request details contain validationType and its request as key and value respectively.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ValidationInputRequest"
+ }
+ }
+ },
+ "discriminator": "validationCategory"
+ },
+ "ValidationResponse": {
+ "description": "Response of pre job creation validations.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ValidationResponseProperties",
+ "description": "Properties of pre job creation validation response.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ValidationResponseProperties": {
+ "description": "Properties of pre job creation validation response.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Overall validation status.",
+ "enum": [
+ "AllValidToProceed",
+ "InputsRevisitRequired",
+ "CertainInputValidationsSkipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "OverallValidationStatus",
+ "modelAsExtensible": true,
+ "values": [
+ {
+ "value": "AllValidToProceed",
+ "description": "Every input request is valid."
+ },
+ {
+ "value": "InputsRevisitRequired",
+ "description": "Some input requests are not valid."
+ },
+ {
+ "value": "CertainInputValidationsSkipped",
+ "description": "Certain input validations skipped."
+ }
+ ]
+ }
+ },
+ "individualResponseDetails": {
+ "description": "List of response details contain validationType and its response as key and value respectively.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ValidationInputResponse"
+ },
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The API Version",
+ "required": true,
+ "type": "string"
+ },
+ "jobNameParameter": {
+ "name": "jobName",
+ "in": "path",
+ "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only",
+ "required": true,
+ "type": "string",
+ "maxLength": 24,
+ "minLength": 3,
+ "pattern": "^[-\\w\\.]+$",
+ "x-ms-parameter-location": "method"
+ },
+ "locationParameter": {
+ "name": "location",
+ "in": "path",
+ "description": "The location of the resource",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The Resource Group Name",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The Subscription Id",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow",
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/AvailableSkusPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/AvailableSkusPost.json
new file mode 100644
index 000000000000..5bf197309c6e
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/AvailableSkusPost.json
@@ -0,0 +1,289 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "bvttoolrg6",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "ce815189-a9cc-4288-8166-d78f211bed5a"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "84"
+ ],
+ "availableSkuRequest": {
+ "transferType": "ImportToAzure",
+ "country": "US",
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "sku": {
+ "name": "DataBox"
+ },
+ "enabled": true,
+ "properties": {
+ "dataLocationToServiceLocationMap": [
+ {
+ "dataLocation": "westus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "northcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "southcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centraluseuap",
+ "serviceLocation": "centraluseuap"
+ },
+ {
+ "dataLocation": "eastus2euap",
+ "serviceLocation": "eastus2euap"
+ }
+ ],
+ "capacity": {
+ "usable": "80",
+ "maximum": "100"
+ },
+ "costs": [
+ {
+ "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042",
+ "meterType": "DataBoxServiceFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "a701f058-119b-4713-a923-bed7da4b7801",
+ "meterType": "DataBoxShippingFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "049fa331-0a48-4a81-9991-a6bef3c79fed",
+ "meterType": "DataBoxExtraDayFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "c3ea978d-6a0a-4632-b094-4fffcafcb057",
+ "meterType": "DataBoxLostOrDamagedDeviceFee",
+ "multiplier": 1
+ }
+ ],
+ "apiVersions": [
+ "2018-01-01"
+ ],
+ "disabledReason": "None",
+ "countriesWithinCommerceBoundary": [
+ "US"
+ ]
+ }
+ },
+ {
+ "sku": {
+ "name": "DataBoxDisk"
+ },
+ "enabled": true,
+ "properties": {
+ "dataLocationToServiceLocationMap": [
+ {
+ "dataLocation": "westus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "northcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "southcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centraluseuap",
+ "serviceLocation": "centraluseuap"
+ },
+ {
+ "dataLocation": "eastus2euap",
+ "serviceLocation": "eastus2euap"
+ }
+ ],
+ "capacity": {
+ "usable": "35",
+ "maximum": "40"
+ },
+ "costs": [
+ {
+ "meterId": "d95cd8b5-b6f1-4cd9-ae86-a016d1945d6f",
+ "meterType": "DataBoxDiskServiceFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "4b8cf572-cb04-4ef3-9528-2cda4e9b544e",
+ "meterType": "DataBoxDiskShippingFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "b6ae9bbf-815d-49dd-bb2b-77c497b72ba4",
+ "meterType": "DataBoxDiskDailyUsageFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "08bc0ea1-6c82-421b-b953-2a7a65810d2e",
+ "meterType": "DataBoxDiskLostDeviceFee",
+ "multiplier": 1
+ }
+ ],
+ "apiVersions": [
+ "2018-01-01"
+ ],
+ "disabledReason": "None",
+ "countriesWithinCommerceBoundary": [
+ "US"
+ ]
+ }
+ },
+ {
+ "sku": {
+ "name": "DataBoxHeavy"
+ },
+ "enabled": true,
+ "properties": {
+ "dataLocationToServiceLocationMap": [
+ {
+ "dataLocation": "westus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "eastus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "northcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "southcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westcentralus",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "westus2",
+ "serviceLocation": "westus"
+ },
+ {
+ "dataLocation": "centraluseuap",
+ "serviceLocation": "centraluseuap"
+ },
+ {
+ "dataLocation": "eastus2euap",
+ "serviceLocation": "eastus2euap"
+ }
+ ],
+ "capacity": {
+ "usable": "800",
+ "maximum": "1000"
+ },
+ "costs": [
+ {
+ "meterId": "d0dccaaf-3de9-4c7a-ba97-f83551b90126",
+ "meterType": "DataBoxHeavyServiceFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "7b49d11f-d4f7-4029-a197-04998fd282f9",
+ "meterType": "DataBoxHeavyShippingFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "c2c66d53-11b4-4f11-9642-43c7c336f0b7",
+ "meterType": "DataBoxHeavyExtraDayFee",
+ "multiplier": 1
+ },
+ {
+ "meterId": "188dcd7e-fbd7-4a41-aa42-162b81b0510f",
+ "meterType": "DataBoxHeavyLostOrDamagedDeviceFee",
+ "multiplier": 1
+ }
+ ],
+ "apiVersions": [
+ "2018-01-01"
+ ],
+ "disabledReason": "None",
+ "requiredFeature": "HeavyCreateAccess",
+ "countriesWithinCommerceBoundary": [
+ "US"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/BookShipmentPickupPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/BookShipmentPickupPost.json
new file mode 100644
index 000000000000..c31c67021363
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/BookShipmentPickupPost.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "bvttoolrg6",
+ "jobName": "TJ-636646322037905056",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "e1437186-b41d-492e-9b7a-e197c28a517a"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.27817.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18362.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "118"
+ ],
+ "shipmentPickUpRequest": {
+ "startTime": "2019-09-20T18:30:00Z",
+ "endTime": "2019-09-22T18:30:00Z",
+ "shipmentLocation": "Front desk"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "confirmationNumber": "2929602E9CP",
+ "readyByTime": "2019-09-20T18:30:00Z"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobMitigate.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobMitigate.json
new file mode 100644
index 000000000000..3ab45ff73e80
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobMitigate.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg9836",
+ "jobName": "SdkJob8367",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "71d282dc-56a0-402b-a322-3b50c89711b5"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.26614.01",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "60"
+ ],
+ "mitigateJobRequest": {
+ "serialNumberCustomerResolutionMap": {
+ "testDISK-1": "MoveToCleanUpDevice",
+ "testDISK-2": "Resume"
+ }
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCancelPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCancelPost.json
new file mode 100644
index 000000000000..36bda0881eca
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCancelPost.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "jobName": "SdkJob952",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "95fc15f7-4976-46bb-8370-74ed4cb676be"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "30"
+ ],
+ "cancellationReason": {
+ "reason": "CancelTest"
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreate.json
new file mode 100644
index 000000000000..5fb9d08d23f0
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreate.json
@@ -0,0 +1,184 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "jobName": "SdkJob952",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "04f2835f-a2a2-4f25-96df-568460e5be24"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1064"
+ ],
+ "jobResource": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "details": {
+ "jobDetailsType": "DataBox",
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount"
+ }
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "sku": {
+ "name": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2019-09-21T14:49:49.0027611+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2019-09-21T14:49:52.3995743+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": []
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob952",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDevicePassword.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDevicePassword.json
new file mode 100644
index 000000000000..0715a41bdd7b
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDevicePassword.json
@@ -0,0 +1,186 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg7478",
+ "jobName": "SdkJob9640",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "c4c8f926-ebbe-4c07-ae1a-b716911058df"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1168"
+ ],
+ "jobResource": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "details": {
+ "jobDetailsType": "DataBox",
+ "devicePassword": "",
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2",
+ "sharePassword": ""
+ }
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "sku": {
+ "name": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2019-09-21T14:49:49.0027611+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2019-09-21T14:49:52.3995743+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": []
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob9640",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7478/providers/Microsoft.DataBox/jobs/SdkJob9640",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDoubleEncryption.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDoubleEncryption.json
new file mode 100644
index 000000000000..bd6e3ab08e4b
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateDoubleEncryption.json
@@ -0,0 +1,189 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg608",
+ "jobName": "SdkJob6599",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "c9c24c55-fd51-4374-839e-60ee5f0d8832"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29220.03",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.19041.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1186"
+ ],
+ "jobResource": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "details": {
+ "jobDetailsType": "DataBox",
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount"
+ }
+ }
+ ],
+ "preferences": {
+ "encryptionPreferences": {
+ "doubleEncryption": "Enabled"
+ }
+ }
+ }
+ },
+ "location": "westus",
+ "sku": {
+ "name": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2019-09-21T14:49:49.0027611+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2019-09-21T14:49:52.3995743+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": []
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob6599",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg608/providers/Microsoft.DataBox/jobs/SdkJob6599",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateExport.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateExport.json
new file mode 100644
index 000000000000..599e37fa53a9
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateExport.json
@@ -0,0 +1,194 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg8091",
+ "jobName": "SdkJob6429",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "80eaafc7-e8b7-4c5a-ad81-b1ecb9573cd4"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1395"
+ ],
+ "jobResource": {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "details": {
+ "jobDetailsType": "DataBox",
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "dataExportDetails": [
+ {
+ "transferConfiguration": {
+ "transferConfigurationType": "TransferAll",
+ "transferAllDetails": {
+ "include": {
+ "dataAccountType": "StorageAccount",
+ "transferAllBlobs": true,
+ "transferAllFiles": true
+ }
+ }
+ },
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2"
+ }
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "sku": {
+ "name": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2019-09-21T14:49:49.0027611+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2019-09-21T14:49:52.3995743+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": []
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob6429",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8091/providers/Microsoft.DataBox/jobs/SdkJob6429",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateWithUserAssignedIdentity.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateWithUserAssignedIdentity.json
new file mode 100644
index 000000000000..aff7720b4fa2
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsCreateWithUserAssignedIdentity.json
@@ -0,0 +1,190 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg7552",
+ "jobName": "SdkJob5337",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "618b064d-967c-4156-a8dd-a9867cc22af9"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29220.03",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.19041.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1318"
+ ],
+ "jobResource": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "details": {
+ "jobDetailsType": "DataBox",
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2"
+ }
+ }
+ ]
+ }
+ },
+ "location": "westus",
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2019-09-21T14:49:49.0027611+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2019-09-21T14:49:52.3995743+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": []
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob5337",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7552/providers/Microsoft.DataBox/jobs/SdkJob5337",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsDelete.json
new file mode 100644
index 000000000000..520c40866aa1
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsDelete.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "jobName": "SdkJob952",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "f5c227e2-13d8-4ce9-9ef2-f3c63f6935b9"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/locations/westus/operationResults/e1fb035c-d0d1-47b9-92fc-4c814eb79571?api-version=2022-09-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGet.json
new file mode 100644
index 000000000000..030d9124a383
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGet.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "jobName": "SdkJob952",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "e76214b0-6013-499e-8f91-3a287f421f2e"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": true,
+ "status": "DeviceOrdered",
+ "startTime": "2020-08-07T10:50:36.3341513+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2020-08-07T10:50:40.1872217+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deliveryPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "returnPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount",
+ "dataAccountType": "StorageAccount"
+ }
+ }
+ ],
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": [],
+ "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=urwfAELvNV69IGHdcXlRCn6o3O3dWZQKaRipmoAdrI0%3D&st=2020-08-07T05%3A10%3A58Z&se=2020-08-08T05%3A20%3A58Z&sp=r",
+ "keyEncryptionKey": {
+ "kekType": "MicrosoftManaged"
+ }
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "SdkJob952",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCmk.json
new file mode 100644
index 000000000000..82220fee6bb5
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCmk.json
@@ -0,0 +1,170 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg7937",
+ "jobName": "SdkJob1735",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "c8cf9d3e-55f1-488f-bcee-53f4939f44e8"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": true,
+ "status": "DeviceOrdered",
+ "startTime": "2020-08-07T10:47:42.0009935+05:30",
+ "details": {
+ "copyProgress": [],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2020-08-07T10:47:44.8736499+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "None"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Public SDK Test",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deliveryPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "returnPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/databoxbvt1/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount2",
+ "dataAccountType": "StorageAccount"
+ }
+ }
+ ],
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": [],
+ "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=JSZSeKrFrrwWbZ4zd7PNdGdNYKExKpxa98vRDDH6ZIk%3D&st=2020-08-07T05%3A08%3A51Z&se=2020-08-08T05%3A18%3A51Z&sp=r",
+ "keyEncryptionKey": {
+ "kekType": "CustomerManaged",
+ "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/",
+ "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault"
+ }
+ },
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "9a68a7c4-0a18-4d06-a5fb-7058e9e98458",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "name": "SdkJob1735",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7937/providers/Microsoft.DataBox/jobs/SdkJob1735",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCopyStuck.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCopyStuck.json
new file mode 100644
index 000000000000..de8976fa11bb
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetCopyStuck.json
@@ -0,0 +1,202 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "dmstestresource",
+ "jobName": "TJx-637505258985313014",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "bdcc8e76-b662-42a4-93fd-5554809712d7"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.26614.01",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": true,
+ "status": "CompletedWithWarnings",
+ "startTime": "2021-03-05T12:56:12.6384315+05:30",
+ "details": {
+ "copyProgress": [
+ {
+ "storageAccountName": "databoxbvttestaccount",
+ "transferType": "ImportToAzure",
+ "dataAccountType": "StorageAccount",
+ "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount",
+ "bytesProcessed": 2000,
+ "totalBytesToProcess": 2000,
+ "filesProcessed": 100,
+ "totalFilesToProcess": 110,
+ "invalidFilesProcessed": 10,
+ "invalidFileBytesUploaded": 10,
+ "renamedContainerCount": 60,
+ "filesErroredOut": 0,
+ "directoriesErroredOut": 0,
+ "invalidDirectoriesProcessed": 0,
+ "isEnumerationInProgress": false
+ }
+ ],
+ "expectedDataSizeInTeraBytes": 0,
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T12:56:25.3911023+05:30"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T13:07:49.676421+05:30"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T02:21:06+05:30"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T02:21:13+05:30"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T02:23:10+05:30"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T02:23:17+05:30"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T13:34:20.1497635+05:30"
+ },
+ {
+ "stageName": "CompletedWithWarnings",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-05T14:08:38.250614+05:30"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Andrew Tribone",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "ssemmail@microsoft.com",
+ "vishwamdir@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "164 TOWNSEND ST",
+ "streetAddress2": "UNIT 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "None"
+ },
+ "deliveryPackage": {
+ "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=5fb6965e-0b80-4f38-b21a-32673fed2d84",
+ "carrierName": "Ups",
+ "trackingId": "5fb6965e-0b80-4f38-b21a-32673fed2d84"
+ },
+ "returnPackage": {
+ "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=b3875a34-aad6-4dbe-83a9-3f39cb21b0e8",
+ "carrierName": "Ups",
+ "trackingId": "b3875a34-aad6-4dbe-83a9-3f39cb21b0e8"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount",
+ "dataAccountType": "StorageAccount"
+ }
+ }
+ ],
+ "jobDetailsType": "DataBox",
+ "preferences": {},
+ "copyLogDetails": [
+ {
+ "accountName": "databoxbvttestaccount",
+ "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml",
+ "copyLogDetailsType": "DataBox"
+ }
+ ],
+ "reverseShipmentLabelSasKey": "http://wusbeta.blob.core.windows.net/devstoreaccount1/f6be6ea8-77da-419b-9f6b-3043c28b04e4/ReverseShipment/b3875a34-aad6-4dbe-83a9-3f39cb21b0e8.PDF?sv=2018-03-28&sr=b&sig=%2BJmOyIkG0ALrKQp%2F7NCOBYccQ80DRLvN%2FHtb6Z97heg%3D&st=2021-03-05T09%3A45%3A05Z&se=2021-03-05T10%3A15%3A05Z&sp=r",
+ "keyEncryptionKey": {
+ "kekType": "MicrosoftManaged"
+ },
+ "actions": [],
+ "lastMitigationActionOnJob": {
+ "actionDateTimeInUtc": "2021-03-05T08:28:18.8107951Z",
+ "isPerformedByCustomer": true,
+ "customerResolution": "MoveToCleanUpDevice"
+ }
+ },
+ "deliveryType": "NonScheduled",
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {
+ "defaultTagsKey": "defaultTagsValue"
+ },
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "TJx-637505258985313014",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/dmstestresource/providers/Microsoft.DataBox/jobs/TJx-637505258985313014",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetExport.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetExport.json
new file mode 100644
index 000000000000..99096ffdd950
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetExport.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg8091",
+ "jobName": "SdkJob6429",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "b3739c7c-02b6-46c2-a04c-da6f8bca279c"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": true,
+ "status": "Cancelled",
+ "startTime": "2020-08-07T10:49:08.7195419+05:30",
+ "details": {
+ "copyProgress": [
+ {
+ "storageAccountName": "aaaaaa2",
+ "transferType": "ExportFromAzure",
+ "dataAccountType": "StorageAccount",
+ "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2",
+ "bytesProcessed": 0,
+ "totalBytesToProcess": 0,
+ "isEnumerationInProgress": false
+ }
+ ],
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2020-08-07T10:49:12.7675644+05:30"
+ },
+ {
+ "stageName": "Cancelled",
+ "displayName": "Canceled",
+ "stageStatus": "Succeeded",
+ "stageTime": "2020-08-07T10:49:57.2572438+05:30"
+ }
+ ],
+ "contactDetails": {
+ "contactName": " ",
+ "emailList": [],
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "notificationPreference": []
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deliveryPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "returnPackage": {
+ "carrierName": "",
+ "trackingId": "",
+ "trackingUrl": ""
+ },
+ "dataImportDetails": [],
+ "dataExportDetails": [
+ {
+ "transferConfiguration": {
+ "transferConfigurationType": "TransferAll",
+ "transferFilterDetails": {},
+ "transferAllDetails": {
+ "include": {
+ "dataAccountType": "StorageAccount",
+ "transferAllBlobs": true,
+ "transferAllFiles": true
+ }
+ }
+ },
+ "logCollectionLevel": "Error",
+ "accountDetails": {
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.Storage/storageAccounts/aaaaaa2",
+ "dataAccountType": "StorageAccount"
+ }
+ }
+ ],
+ "jobDetailsType": "DataBox",
+ "copyLogDetails": [],
+ "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/customer-reverse-shipment-instructions/CustomerShipmentInstructions_MicrosoftManaged.PDF?sv=2018-03-28&sr=b&sig=04aL%2FTe7998qQJlhmGI3C0Q%2FxsCVo1t0B4uQUIx7TmQ%3D&st=2020-08-07T05%3A10%3A05Z&se=2020-08-08T05%3A20%3A05Z&sp=r",
+ "chainOfCustodySasKey": "https://wusbeta.blob.core.windows.net/chainofcustody/9a6ee052-bcff-4b5e-a478-7dcbfb86e9fb.txt?sv=2018-03-28&sr=b&sig=JbBBXZKharvfg35ZfmrhowO1DuOpzcZCNUdeFzklvWs%3D&st=2020-08-07T05%3A10%3A05Z&se=2020-08-07T05%3A40%3A05Z&sp=r",
+ "keyEncryptionKey": {
+ "kekType": "MicrosoftManaged"
+ }
+ },
+ "cancellationReason": "CancelTest",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "SdkJob6429",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8091/providers/Microsoft.DataBox/jobs/SdkJob6429",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetWaitingForAction.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetWaitingForAction.json
new file mode 100644
index 000000000000..af2ce26a6141
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsGetWaitingForAction.json
@@ -0,0 +1,251 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "dmstestresource",
+ "jobName": "TJx-637505258985313014",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "bdcc8e76-b662-42a4-93fd-5554809712d7"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.26614.01",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": false,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": true,
+ "status": "DataCopy",
+ "startTime": "2021-03-14T23:49:49.5177298+00:00",
+ "error": {
+ "code": "SsemUserCopyErrorWaitingForAction",
+ "message": "Job has an error in copy stage and is waiting for customer action. Please review the error and select one of the actions provided in the job's properties.details.actions",
+ "target": "CopyIntervention",
+ "details": [],
+ "additionalInfo": []
+ },
+ "details": {
+ "copyProgress": [
+ {
+ "storageAccountName": "databoxbvttestaccount",
+ "transferType": "ImportToAzure",
+ "dataAccountType": "StorageAccount",
+ "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount",
+ "bytesProcessed": 2000,
+ "totalBytesToProcess": 2000,
+ "filesProcessed": 100,
+ "totalFilesToProcess": 110,
+ "invalidFilesProcessed": 10,
+ "invalidFileBytesUploaded": 10,
+ "renamedContainerCount": 60,
+ "filesErroredOut": 0,
+ "directoriesErroredOut": 0,
+ "invalidDirectoriesProcessed": 0,
+ "isEnumerationInProgress": false
+ },
+ {
+ "transferType": "ImportToAzure",
+ "dataAccountType": "ManagedDisk",
+ "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94",
+ "bytesProcessed": 2000,
+ "totalBytesToProcess": 2000,
+ "filesProcessed": 100,
+ "totalFilesToProcess": 110,
+ "invalidFilesProcessed": 10,
+ "invalidFileBytesUploaded": 10,
+ "renamedContainerCount": 60,
+ "filesErroredOut": 0,
+ "directoriesErroredOut": 0,
+ "invalidDirectoriesProcessed": 0,
+ "isEnumerationInProgress": false
+ }
+ ],
+ "expectedDataSizeInTeraBytes": 0,
+ "jobStages": [
+ {
+ "stageName": "DeviceOrdered",
+ "displayName": "Ordered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-14T23:49:53.81509+00:00"
+ },
+ {
+ "stageName": "DevicePrepared",
+ "displayName": "Processed",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-15T00:05:18.7350971+00:00"
+ },
+ {
+ "stageName": "Dispatched",
+ "displayName": "Dispatched",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-15T00:25:19+00:00"
+ },
+ {
+ "stageName": "Delivered",
+ "displayName": "Delivered",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-15T00:25:26+00:00"
+ },
+ {
+ "stageName": "PickedUp",
+ "displayName": "Picked up",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-15T00:30:22+00:00"
+ },
+ {
+ "stageName": "AtAzureDC",
+ "displayName": "Received",
+ "stageStatus": "Succeeded",
+ "stageTime": "2021-03-15T00:30:29+00:00"
+ },
+ {
+ "stageName": "DataCopy",
+ "displayName": "Data copy in progress",
+ "stageStatus": "WaitingForCustomerAction",
+ "stageTime": "2021-03-15T00:45:26.2679756+00:00"
+ },
+ {
+ "stageName": "Completed",
+ "displayName": "Completed",
+ "stageStatus": "None"
+ }
+ ],
+ "contactDetails": {
+ "contactName": "Andrew Tribone",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "ssemmail@microsoft.com",
+ "vishwamdir@microsoft.com"
+ ],
+ "notificationPreference": [
+ {
+ "stageName": "DevicePrepared",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Dispatched",
+ "sendNotification": true
+ },
+ {
+ "stageName": "Delivered",
+ "sendNotification": true
+ },
+ {
+ "stageName": "PickedUp",
+ "sendNotification": true
+ },
+ {
+ "stageName": "AtAzureDC",
+ "sendNotification": true
+ },
+ {
+ "stageName": "DataCopy",
+ "sendNotification": true
+ }
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "164 TOWNSEND ST",
+ "streetAddress2": "UNIT 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "None"
+ },
+ "deliveryPackage": {
+ "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=6f00fcce-1eec-4ee7-99a8-0acc68efd1c7",
+ "carrierName": "Ups",
+ "trackingId": "6f00fcce-1eec-4ee7-99a8-0acc68efd1c7"
+ },
+ "returnPackage": {
+ "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=79148759-b772-4a90-933b-da5ae5ac6ebb",
+ "carrierName": "Ups",
+ "trackingId": "79148759-b772-4a90-933b-da5ae5ac6ebb"
+ },
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount",
+ "dataAccountType": "StorageAccount"
+ }
+ },
+ {
+ "accountDetails": {
+ "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94",
+ "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/manageddisktest/providers/Microsoft.Storage/storageAccounts/sojainmanageddisk",
+ "dataAccountType": "ManagedDisk"
+ }
+ }
+ ],
+ "jobDetailsType": "DataBox",
+ "preferences": {
+ "encryptionPreferences": {
+ "doubleEncryption": "Disabled"
+ }
+ },
+ "copyLogDetails": [
+ {
+ "accountName": "databoxbvttestaccount",
+ "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml",
+ "copyLogDetailsType": "DataBox"
+ },
+ {
+ "accountName": "akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ94",
+ "copyLogLink": "databoxcopylog/strtrinidad01_ZTS18520041_CopyLog_8425fb8f9c2b447288caa4dd6f5d34bb.xml",
+ "copyLogDetailsType": "DataBox"
+ }
+ ],
+ "reverseShipmentLabelSasKey": "https://wusbeta.blob.core.windows.net/10dcd296-ed09-4037-ac19-2f16c4866452/ReverseShipment/79148759-b772-4a90-933b-da5ae5ac6ebb.PDF?sv=2018-03-28&sr=b&sig=bNtVcKRfYq1kiz0vxxSV%2FIZodCK8nUsCPu6MYK%2B6Erk%3D&st=2021-06-21T15%3A35%3A29Z&se=2021-06-21T16%3A05%3A29Z&sp=r",
+ "keyEncryptionKey": {
+ "kekType": "MicrosoftManaged"
+ },
+ "actions": [
+ "MoveToCleanUpDevice"
+ ],
+ "lastMitigationActionOnJob": {
+ "actionDateTimeInUtc": "2021-05-12T05:00:22.5047578Z",
+ "isPerformedByCustomer": true,
+ "customerResolution": "MoveToCleanUpDevice"
+ }
+ },
+ "deliveryType": "NonScheduled",
+ "isCancellableWithoutFee": false
+ },
+ "systemData": {
+ "createdBy": "5ff6737b-7c50-45d1-b2cb-63a6cd723138",
+ "createdByType": "Application",
+ "createdAt": "2021-03-14T23:49:48.349255+00:00",
+ "lastModifiedBy": "5ff6737b-7c50-45d1-b2cb-63a6cd723138",
+ "lastModifiedByType": "Application",
+ "lastModifiedAt": "2021-03-14T23:49:48.349255+00:00"
+ },
+ "location": "westus",
+ "tags": {
+ "defaultTagsKey": "defaultTagsValue"
+ },
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "TJx-637505258985313014",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/dmstestresource/providers/Microsoft.DataBox/jobs/TJx-637505258985313014",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsList.json
new file mode 100644
index 000000000000..5563b3f296df
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsList.json
@@ -0,0 +1,805 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "044127c5-663e-4a0f-9061-2fa0ca8058c4"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2018-08-30T14:44:39.77401+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "australiaeast",
+ "tags": {},
+ "sku": {
+ "name": "DataBoxDisk"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "mnaustest",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/ausresgrpmn/providers/Microsoft.DataBox/jobs/mnaustest",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2018-09-10T18:03:22.2578238+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "australiaeast",
+ "tags": {},
+ "sku": {
+ "name": "DataBoxDisk"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "portalcontractAUS",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/ausresgrpmn/providers/Microsoft.DataBox/jobs/portalcontractAUS",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2018-08-30T15:17:17.3753642+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "australiaeast",
+ "tags": {},
+ "sku": {
+ "name": "DataBoxDisk"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testBB-diskAU",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/testBB/providers/Microsoft.DataBox/jobs/testBB-diskAU",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-04T11:12:15.5972523+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "allXML",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/allXML",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-07T15:51:08.4479315+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "bothExportAllxml",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/bothExportAllxml",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-04T19:44:59.2410723+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "exportAll",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/exportAll",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-04T18:31:05.3036028+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "importRegressnTest",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/importRegressnTest",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-09T01:57:03.8985885+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testBotthXMLAndAll",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testBotthXMLAndAll",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-05T15:56:52.6983398+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testExportAllOrder",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testExportAllOrder",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-04T17:45:25.464989+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testPayload",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/testPayload",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-04T10:43:04.8775864+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "xmlOnlyOrder",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat12/providers/Microsoft.DataBox/jobs/xmlOnlyOrder",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2018-11-27T15:17:49.0760408+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testbadresourcegroup",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat3198inh0-9)inh(il(h)_fyoin)(upf(yLASD0-FJ(hal-DSNWP0JDS0P3-0SJ93/providers/Microsoft.DataBox/jobs/testbadresourcegroup",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2019-01-04T09:08:49.9928621+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "andipodtest4jan",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/andipodtest4jan",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-05-28T15:20:48.1058546+05:30",
+ "cancellationReason": "NoLongerNeeded null",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "dbtest1",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/dbtest1",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-14T08:51:18.2067875+05:30",
+ "cancellationReason": "IncorrectOrder null",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "degautam14-04-Clone",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautam14-04-Clone",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-27T18:08:30.6622356+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "degautamtestexport",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamtestexport",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-21T20:41:02.3837388+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "DegautamTestExportOrder",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/DegautamTestExportOrder",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-24T07:56:23.6839464+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "degautamtestorder",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamtestorder",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-14T08:48:21.2260174+05:30",
+ "cancellationReason": "IncorrectOrder null",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "degautamTestOrder14-04",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/degautamTestOrder14-04",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-05-12T12:19:19.8627264+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "export",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/export",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-05T19:50:20.9692355+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "exportTestResource",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/exportTestResource",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-10T15:09:45.7080012+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "sanakTestImportNew",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportNew",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-10T15:13:02.5724966+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "sanakTestImportOld",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ExportFromAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-20T13:39:28.1940929+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "sanakTestImportOld1",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld1",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2020-04-10T15:14:59.6879599+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "sanakTestImportOld2",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.DataBox/jobs/sanakTestImportOld2",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": false,
+ "status": "DeviceOrdered",
+ "startTime": "2020-07-21T23:43:34.513148+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "saranyagorder",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/saranyagorder",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2019-07-04T14:01:50.9232807+05:30",
+ "cancellationReason": "IncorrectOrder null",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testdeepak04-07",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdeepak04-07",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": false,
+ "isDeletable": true,
+ "isShippingAddressEditable": false,
+ "isPrepareToShipEnabled": false,
+ "status": "Cancelled",
+ "startTime": "2019-02-11T12:33:16.6231232+05:30",
+ "cancellationReason": "Old job which is still in ordered state cancelled by the service",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": false
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBoxHeavy"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "testdurga-heavy",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/akvenkat/providers/Microsoft.DataBox/jobs/testdurga-heavy",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ ],
+ "nextLink": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/jobs?api-version=2020-11-01&%24skiptoken=fVJdb5swFP0v0bq3NMaFFipVU5oATRbSxBjz8WYDIQbzoUBISNX%2fPrfVumnaJvnB8rn3nON77suoSs%2fdildFO7p%2fGfmmiz13dD%2fad13T3k8mJa1olpZp1V3Ty%2fGQXsd1OWmPrI0PvOl4XbWTHb3VgQ53Y323uxurFGpjQ4vvxnFqJFRTFajC3aQ51D1P0kM7cXh8qNt6113PaUcf6%2fMkr1n7jTZ83EtcUj5AAMEYqGOgfP3SFrzBdZFWD5u5oTL%2flCUlGWIoepYD7rjqacEfBSvXfWSLY3QBPAlQucImXOT6FWTzba1voXFMJJr4FqC%2bcSS2cYh89QPNFvPznEFNIpoSBqiRd4%2fBTrBcXc%2f4NFvMpjr51FSHVT7VV0ok4motaz9ZZtNsYyEttj3JS2yLM9uTdT9fpI83pmxjaiJ9QtswWAL6obaKgkL2OK4pBS3KPG%2fAAD2uTaXzA7RBStPhqjg5lvBcbDnEbs9%2b0OSJVQwEE4qAd8YFslJPM91SCdNiWYYiaWm57p6DhjuiPmFbcamNnlApuAP3JfZCLfYXg1vV%2bgr8y9Efnl12k%2fzyCp9nVs5IdBvmaz8l0kuFIt9c3oQkVpjY327LKGc%2beteitnnxyzNnAaojM1QTJbt45Tl3lOUhsvbfmRDY8Q1KQDhEBFkrfOpxSdTEWvYJ6ESKf8vCtoYIEoBtI%2f%2fI6y0D72nZMN8aUtkpp%2f%2bXivffzE%2f9f7dBTmPds0puQUX2cmd6JlBPITlusqubRJ7R6%2bsP"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListByResourceGroup.json
new file mode 100644
index 000000000000..ddbc028fc35b
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListByResourceGroup.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "c1514209-a439-4bd1-b040-76d7539d2509"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": true,
+ "status": "DeviceOrdered",
+ "startTime": "2020-07-03T11:55:54.463792+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "fac84c35-5490-4b11-81b9-770053ccbe3b",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "name": "SdkJob5928",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob5928",
+ "type": "Microsoft.DataBox/jobs"
+ },
+ {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isDeletable": false,
+ "isShippingAddressEditable": true,
+ "isPrepareToShipEnabled": true,
+ "status": "DeviceOrdered",
+ "startTime": "2020-08-07T10:50:36.3341513+05:30",
+ "deliveryType": "NonScheduled",
+ "deliveryInfo": {
+ "scheduledDateTime": "0001-01-01T05:30:00+05:30"
+ },
+ "isCancellableWithoutFee": true
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "name": "SdkJob952",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListCredentials.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListCredentials.json
new file mode 100644
index 000000000000..67dc3b1ad104
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsListCredentials.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "bvttoolrg6",
+ "jobName": "TJ-636646322037905056",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "cda11c92-529b-4b75-b56d-ff1a69ffeeba"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "jobName": "TJ-636646322037905056",
+ "jobSecrets": {
+ "podSecrets": [
+ {
+ "deviceSerialNumber": "testimolapod-3ecc44ce",
+ "devicePassword": "",
+ "networkConfigurations": [
+ {
+ "name": "DataPort3",
+ "macAddress": "D05099C1F439"
+ },
+ {
+ "name": "DataPort1",
+ "macAddress": "EC0D9A21A6C0"
+ },
+ {
+ "name": "DataPort2",
+ "macAddress": "EC0D9A21A6C1"
+ }
+ ],
+ "encodedValidationCertPubKey": "5CYoAoVKEBa4WgPVis8keX94w30pon4jGMADSqcdE/NlHLChj6Cmhbl4q9QOFKSB/US4AwhS7zY1QS3YMDrkAPfOy7Hi6kWMBpJWZidTq3oXX8FAQjg+IqQESti/2jvAlcDpO2453rgd7Yb6XZ43P8MMTpTjcarI0ImCf//eITQWnFa3AzfIJ9C+hxCCaA7HTYhwQEPUBMwyQJsI6v6WuQysROtlBgx1YtbWFhDVbcqYRSLIbaj+RdzlvxvDJSo70kv+8em5upuDTpVE7xP+WePLlARdSPNwwfRzHnvCUqC2UqXHpRUhQlYnMqAJEcjjroRnyIGumPmmQ8O155X8aw==",
+ "accountCredentialDetails": [
+ {
+ "accountName": "databoxbvttestaccount",
+ "dataAccountType": "StorageAccount",
+ "accountConnectionString": "",
+ "shareCredentialDetails": [
+ {
+ "shareName": "databoxbvttestaccount_PageBlob",
+ "shareType": "PageBlob",
+ "userName": "databoxbvttestac_903",
+ "password": "",
+ "supportedAccessProtocols": [
+ "SMB"
+ ]
+ },
+ {
+ "shareName": "databoxbvttestaccount_BlockBlob",
+ "shareType": "BlockBlob",
+ "userName": "databoxbvttestac_903",
+ "password": "",
+ "supportedAccessProtocols": [
+ "SMB"
+ ]
+ },
+ {
+ "shareName": "databoxbvttestaccount_AzFile",
+ "shareType": "AzureFile",
+ "userName": "databoxbvttestac_903",
+ "password": "",
+ "supportedAccessProtocols": [
+ "SMB"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "jobSecretsType": "DataBox",
+ "dcAccessSecurityCode": {}
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatch.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatch.json
new file mode 100644
index 000000000000..9502636bc8c0
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatch.json
@@ -0,0 +1,77 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg5154",
+ "jobName": "SdkJob952",
+ "api-version": "2022-10-01",
+ "$expand": "details",
+ "x-ms-client-request-id": [
+ "ff3829ca-bcb0-4737-b6e0-52af57f34bb7"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "584"
+ ],
+ "jobResourceUpdateParameter": {
+ "properties": {
+ "details": {
+ "contactDetails": {
+ "contactName": "Update Job",
+ "phone": "1234567890",
+ "phoneExtension": "1234",
+ "emailList": [
+ "testing@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/locations/westus/operationResults/e1fb035c-d0d1-47b9-92fc-4c814eb79571?api-version=2022-09-01"
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2018-04-13T16:28:38.9999793+05:30"
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob952",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg5154/providers/Microsoft.DataBox/jobs/SdkJob952",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchCmk.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchCmk.json
new file mode 100644
index 000000000000..b4232cf6a6b8
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchCmk.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg7937",
+ "jobName": "SdkJob1735",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "fcab0fa9-7af8-47e0-b570-d703a48ee66b"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "358"
+ ],
+ "jobResourceUpdateParameter": {
+ "properties": {
+ "details": {
+ "keyEncryptionKey": {
+ "kekType": "CustomerManaged",
+ "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/",
+ "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/locations/westus/operationResults/e1fb035c-d0d1-47b9-92fc-4c814eb79571?api-version=2022-09-01"
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2018-04-13T16:28:38.9999793+05:30"
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob1735",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg7937/providers/Microsoft.DataBox/jobs/SdkJob1735",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchSystemAssignedToUserAssigned.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchSystemAssignedToUserAssigned.json
new file mode 100644
index 000000000000..6ce05d7749d5
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/JobsPatchSystemAssignedToUserAssigned.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg9765",
+ "jobName": "SdkJob2965",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "25b11bec-6551-47a4-9ee2-575245cbfd45"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29220.03",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.19041.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.2.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "923"
+ ],
+ "jobResourceUpdateParameter": {
+ "properties": {
+ "details": {
+ "keyEncryptionKey": {
+ "kekType": "CustomerManaged",
+ "identityProperties": {
+ "type": "UserAssigned",
+ "userAssigned": {
+ "resourceId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity"
+ }
+ },
+ "kekUrl": "https://sdkkeyvault.vault.azure.net/keys/SSDKEY/",
+ "kekVaultResourceID": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.KeyVault/vaults/SDKKeyVault"
+ }
+ }
+ },
+ "identity": {
+ "type": "SystemAssigned,UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/akvenkat/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sdkIdentity": {}
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/providers/Microsoft.DataBox/locations/westus/operationResults/e1fb035c-d0d1-47b9-92fc-4c814eb79571?api-version=2022-09-01"
+ }
+ },
+ "200": {
+ "body": {
+ "properties": {
+ "transferType": "ImportToAzure",
+ "isCancellable": true,
+ "isShippingAddressEditable": true,
+ "status": "DeviceOrdered",
+ "startTime": "2018-04-13T16:28:38.9999793+05:30"
+ },
+ "location": "westus",
+ "tags": {},
+ "sku": {
+ "name": "DataBox"
+ },
+ "name": "SdkJob2965",
+ "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9765/providers/Microsoft.DataBox/jobs/SdkJob2965",
+ "type": "Microsoft.DataBox/jobs"
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/MarkDevicesShipped.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/MarkDevicesShipped.json
new file mode 100644
index 000000000000..fa9973ac1a21
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/MarkDevicesShipped.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg9836",
+ "jobName": "SdkJob8367",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "71d282dc-56a0-402b-a322-3b50c89711b5"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.26614.01",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "60"
+ ],
+ "markDevicesShippedRequest": {
+ "deliverToDcPackageDetails": {
+ "carrierName": "DHL",
+ "trackingId": "123456"
+ }
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/OperationsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/OperationsGet.json
new file mode 100644
index 000000000000..110db9eb2091
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/OperationsGet.json
@@ -0,0 +1,212 @@
+{
+ "parameters": {
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "b9453354-c675-40a8-99c0-8039818c85fd"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataBox/locations/operationResults/read",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Operation Results",
+ "operation": "List Operation Results",
+ "description": "List or get the Operation Results"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/cancel/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "Cancel",
+ "description": "Cancels an order in progress."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "Book Shipment Pick Up",
+ "description": "Allows to book a pick up for return shipments."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/read",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "List Orders",
+ "description": "List or get the Orders"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/delete",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "Delete Orders",
+ "description": "Delete the Orders"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/write",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "Create or Update Orders",
+ "description": "Create or update the Orders"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/jobs/listCredentials/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Orders",
+ "operation": "List Credentials",
+ "description": "Lists the unencrypted credentials related to the order."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/locations/validateInputs/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Validate Inputs",
+ "operation": "Validate Inputs",
+ "description": "This method does all type of validations."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/locations/validateAddress/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Validate Address",
+ "operation": "Validate Address",
+ "description": "Validates the shipping address and provides alternate addresses if any."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/subscriptions/resourceGroups/moveResources/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Move Resource",
+ "operation": "Move Resource",
+ "description": "This method performs the resource move."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/subscriptions/resourceGroups/validateMoveResources/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Move Resource",
+ "operation": "Validate Move Resource Request",
+ "description": "This method validates whether resource move is allowed or not."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/locations/availableSkus/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Available Skus",
+ "operation": "Availabe Skus",
+ "description": "This method returns the list of available skus."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/locations/regionConfiguration/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Region Configuration",
+ "operation": "Region Configuration",
+ "description": "This method returns the configurations for the region."
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/locations/availableSkus/read",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Available Skus",
+ "operation": "List Available Skus",
+ "description": "List or get the Available Skus"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/register/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Register Microsoft.Databox",
+ "operation": "Register Microsoft.Databox",
+ "description": "Register Provider Microsoft.Databox"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/unregister/action",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Register Microsoft.Databox",
+ "operation": "Un-Register Microsoft.Databox",
+ "description": "Un-Register Provider Microsoft.Databox"
+ },
+ "properties": {},
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBox/operations/read",
+ "display": {
+ "provider": "Azure Data Box",
+ "resource": "Operations",
+ "operation": "List Operations",
+ "description": "List or get the Operations"
+ },
+ "properties": {},
+ "origin": "user"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfiguration.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfiguration.json
new file mode 100644
index 000000000000..3735c434ccbc
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfiguration.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "regionConfigurationRequest": {
+ "scheduleAvailabilityRequest": {
+ "storageLocation": "westus",
+ "skuName": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "scheduleAvailabilityResponse": {
+ "availableDates": [
+ "2019-07-11T00:00:00+00:00",
+ "2019-07-12T00:00:00+00:00",
+ "2019-07-13T00:00:00+00:00",
+ "2019-07-14T00:00:00+00:00",
+ "2019-07-15T00:00:00+00:00",
+ "2019-07-16T00:00:00+00:00",
+ "2019-07-17T00:00:00+00:00",
+ "2019-07-18T00:00:00+00:00",
+ "2019-07-19T00:00:00+00:00",
+ "2019-07-20T00:00:00+00:00",
+ "2019-07-21T00:00:00+00:00",
+ "2019-07-22T00:00:00+00:00",
+ "2019-07-23T00:00:00+00:00",
+ "2019-07-24T00:00:00+00:00",
+ "2019-07-25T00:00:00+00:00",
+ "2019-07-26T00:00:00+00:00",
+ "2019-07-27T00:00:00+00:00",
+ "2019-07-28T00:00:00+00:00",
+ "2019-07-29T00:00:00+00:00",
+ "2019-07-30T00:00:00+00:00",
+ "2019-07-31T00:00:00+00:00"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfigurationByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfigurationByResourceGroup.json
new file mode 100644
index 000000000000..fd8f3158b5d6
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/RegionConfigurationByResourceGroup.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg4981",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "regionConfigurationRequest": {
+ "scheduleAvailabilityRequest": {
+ "storageLocation": "westus",
+ "skuName": "DataBox"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "scheduleAvailabilityResponse": {
+ "availableDates": [
+ "2019-07-11T00:00:00+00:00",
+ "2019-07-12T00:00:00+00:00",
+ "2019-07-13T00:00:00+00:00",
+ "2019-07-14T00:00:00+00:00",
+ "2019-07-15T00:00:00+00:00",
+ "2019-07-16T00:00:00+00:00",
+ "2019-07-17T00:00:00+00:00",
+ "2019-07-18T00:00:00+00:00",
+ "2019-07-19T00:00:00+00:00",
+ "2019-07-20T00:00:00+00:00",
+ "2019-07-21T00:00:00+00:00",
+ "2019-07-22T00:00:00+00:00",
+ "2019-07-23T00:00:00+00:00",
+ "2019-07-24T00:00:00+00:00",
+ "2019-07-25T00:00:00+00:00",
+ "2019-07-26T00:00:00+00:00",
+ "2019-07-27T00:00:00+00:00",
+ "2019-07-28T00:00:00+00:00",
+ "2019-07-29T00:00:00+00:00",
+ "2019-07-30T00:00:00+00:00",
+ "2019-07-31T00:00:00+00:00"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateAddressPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateAddressPost.json
new file mode 100644
index 000000000000..323cc6458eac
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateAddressPost.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "cfda3c52-b129-4568-aba7-e743edf747c2"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "351"
+ ],
+ "validateAddress": {
+ "validationType": "ValidateAddress",
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deviceType": "DataBox"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "validationStatus": "Valid",
+ "alternateAddresses": [
+ {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "streetAddress3": "",
+ "city": "SAN FRANCISCO",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "addressType": "None"
+ }
+ ],
+ "validationType": "ValidateAddress"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputs.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputs.json
new file mode 100644
index 000000000000..abb1d811cde2
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputs.json
@@ -0,0 +1,166 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "129a0589-5017-4f35-a66c-8da38e04aae1"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1675"
+ ],
+ "validationRequest": {
+ "validationCategory": "JobCreationValidation",
+ "individualRequestDetails": [
+ {
+ "validationType": "ValidateDataTransferDetails",
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount"
+ }
+ }
+ ],
+ "deviceType": "DataBox",
+ "transferType": "ImportToAzure"
+ },
+ {
+ "validationType": "ValidateAddress",
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deviceType": "DataBox",
+ "transportPreferences": {
+ "preferredShipmentType": "MicrosoftManaged"
+ }
+ },
+ {
+ "validationType": "ValidateSubscriptionIsAllowedToCreateJob"
+ },
+ {
+ "validationType": "ValidateSkuAvailability",
+ "deviceType": "DataBox",
+ "transferType": "ImportToAzure",
+ "country": "US",
+ "location": "westus"
+ },
+ {
+ "validationType": "ValidateCreateOrderLimit",
+ "deviceType": "DataBox"
+ },
+ {
+ "validationType": "ValidatePreferences",
+ "preference": {
+ "transportPreferences": {
+ "preferredShipmentType": "MicrosoftManaged"
+ }
+ },
+ "deviceType": "DataBox"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "status": "AllValidToProceed",
+ "individualResponseDetails": [
+ {
+ "status": "Valid",
+ "validationType": "ValidateDataTransferDetails",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "validationStatus": "Valid",
+ "alternateAddresses": [
+ {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "streetAddress3": "",
+ "city": "SAN FRANCISCO",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "addressType": "None"
+ }
+ ],
+ "validationType": "ValidateAddress",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateSubscriptionIsAllowedToCreateJob",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateSkuAvailability",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateCreateOrderLimit",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidatePreferences",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputsByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputsByResourceGroup.json
new file mode 100644
index 000000000000..8b804bfd3f3a
--- /dev/null
+++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/examples/ValidateInputsByResourceGroup.json
@@ -0,0 +1,167 @@
+{
+ "parameters": {
+ "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f",
+ "resourceGroupName": "SdkRg6861",
+ "location": "westus",
+ "api-version": "2022-10-01",
+ "x-ms-client-request-id": [
+ "85f045bb-7659-4a2f-bcf5-96723954afdf"
+ ],
+ "Accept-Language": [
+ "en-US"
+ ],
+ "User-Agent": [
+ "FxVersion/4.6.29017.01",
+ "OSName/Windows",
+ "OSVersion/Microsoft.Windows.10.0.18363.",
+ "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0"
+ ],
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "1675"
+ ],
+ "validationRequest": {
+ "validationCategory": "JobCreationValidation",
+ "individualRequestDetails": [
+ {
+ "validationType": "ValidateDataTransferDetails",
+ "dataImportDetails": [
+ {
+ "accountDetails": {
+ "dataAccountType": "StorageAccount",
+ "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount"
+ }
+ }
+ ],
+ "deviceType": "DataBox",
+ "transferType": "ImportToAzure"
+ },
+ {
+ "validationType": "ValidateAddress",
+ "shippingAddress": {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "city": "San Francisco",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "companyName": "Microsoft",
+ "addressType": "Commercial"
+ },
+ "deviceType": "DataBox",
+ "transportPreferences": {
+ "preferredShipmentType": "MicrosoftManaged"
+ }
+ },
+ {
+ "validationType": "ValidateSubscriptionIsAllowedToCreateJob"
+ },
+ {
+ "validationType": "ValidateSkuAvailability",
+ "deviceType": "DataBox",
+ "transferType": "ImportToAzure",
+ "country": "US",
+ "location": "westus"
+ },
+ {
+ "validationType": "ValidateCreateOrderLimit",
+ "deviceType": "DataBox"
+ },
+ {
+ "validationType": "ValidatePreferences",
+ "preference": {
+ "transportPreferences": {
+ "preferredShipmentType": "MicrosoftManaged"
+ }
+ },
+ "deviceType": "DataBox"
+ }
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "status": "AllValidToProceed",
+ "individualResponseDetails": [
+ {
+ "status": "Valid",
+ "validationType": "ValidateDataTransferDetails",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "validationStatus": "Valid",
+ "alternateAddresses": [
+ {
+ "streetAddress1": "16 TOWNSEND ST",
+ "streetAddress2": "Unit 1",
+ "streetAddress3": "",
+ "city": "SAN FRANCISCO",
+ "stateOrProvince": "CA",
+ "country": "US",
+ "postalCode": "94107",
+ "addressType": "None"
+ }
+ ],
+ "validationType": "ValidateAddress",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateSubscriptionIsAllowedToCreateJob",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateSkuAvailability",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidateCreateOrderLimit",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ },
+ {
+ "status": "Valid",
+ "validationType": "ValidatePreferences",
+ "error": {
+ "code": "Success",
+ "target": "KeyEncryptionKey",
+ "details": [],
+ "additionalInfo": []
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databox/resource-manager/readme.go.md b/specification/databox/resource-manager/readme.go.md
index 2527e38173bd..dc5ee050fbbd 100644
--- a/specification/databox/resource-manager/readme.go.md
+++ b/specification/databox/resource-manager/readme.go.md
@@ -41,6 +41,7 @@ batch:
- tag: package-2021-12
- tag: package-2022-02
- tag: package-2022-09
+ - tag: package-2022-10
```
### Tag: package-2018-01 and go
@@ -131,4 +132,13 @@ Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2022-10' && $(go)
+output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-10-01/$(namespace)
```
\ No newline at end of file
diff --git a/specification/databox/resource-manager/readme.java.md b/specification/databox/resource-manager/readme.java.md
index 67b89cbd5a25..9cb50344f8c4 100644
--- a/specification/databox/resource-manager/readme.java.md
+++ b/specification/databox/resource-manager/readme.java.md
@@ -27,6 +27,7 @@ batch:
- tag: package-2021-12
- tag: package-2022-02
- tag: package-2022-09
+ - tag: package-2022-10
```
### Tag: package-2018-01 and java
@@ -157,4 +158,17 @@ java:
output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2022_09_01
regenerate-manager: true
generate-interface: true
+```
+
+### Tag: package-2022-10 and java
+
+These settings apply only when `--tag=package-2022-10-java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=`.
+
+``` yaml $(tag) == 'package-2022-10' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.databox.v2022_10-01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/databox/mgmt-v2022_10_01
+regenerate-manager: true
+generate-interface: true
```
\ No newline at end of file
diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md
index 84271460b3d6..119ed693aa04 100644
--- a/specification/databox/resource-manager/readme.md
+++ b/specification/databox/resource-manager/readme.md
@@ -26,7 +26,16 @@ These are the global settings for the DataBox API.
``` yaml
openapi-type: arm
-tag: package-2022-09
+tag: package-2022-10
+```
+
+### Tag: package-2022-10
+
+These settings apply only when `--tag=package-2022-10` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-10'
+input-file:
+- Microsoft.DataBox/stable/2022-10-01/databox.json
```
### Tag: package-2022-09
diff --git a/specification/databox/resource-manager/readme.python.md b/specification/databox/resource-manager/readme.python.md
index 9b61f5f1d5da..fe9d9cbe8037 100644
--- a/specification/databox/resource-manager/readme.python.md
+++ b/specification/databox/resource-manager/readme.python.md
@@ -23,6 +23,7 @@ Generate all API versions currently shipped for this package
```yaml $(python)
multiapi: true
batch:
+ - tag: package-2022-10
- tag: package-2022-09
- tag: package-2022-02
- tag: package-2021-12
@@ -41,6 +42,16 @@ output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/datab
perform-load: false
```
+### Tag: package-2022-10 and python
+
+These settings apply only when `--tag=package-2022-10 --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-10' && $(python)
+namespace: azure.mgmt.databox.v2022_10_01
+output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox/v2022_10_01
+```
+
### Tag: package-2022-09 and python
These settings apply only when `--tag=package-2022-09 --python` is specified on the command line.
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/databoxedge.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/databoxedge.json
new file mode 100644
index 000000000000..87ad41f1583b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/databoxedge.json
@@ -0,0 +1,10466 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01-preview",
+ "title": "DataBoxEdgeManagementClient"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.DataBoxEdge/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "List all the supported operations.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of supported operations.",
+ "schema": {
+ "$ref": "#/definitions/OperationsList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OperationsGet": {
+ "$ref": "./examples/OperationsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": {
+ "get": {
+ "tags": [
+ "AvailableSkus"
+ ],
+ "summary": "List all the available Skus and information related to them.",
+ "operationId": "AvailableSkus_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists the available Skus and information related to them.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeSkuList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AvailableSkus": {
+ "$ref": "./examples/AvailableSkusList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.",
+ "operationId": "Devices_ListBySubscription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of Data Box Edge/Data Box Gateway devices.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetBySubscription": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.",
+ "operationId": "Devices_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of Data Box Edge/Data Box Gateway devices.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetByResourceGroup": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Box Edge/Data Box Gateway device.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetByName": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByName.json"
+ },
+ "DataBoxEdgeDeviceGetByNameWithDataResidency": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.",
+ "operationId": "Devices_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "dataBoxEdgeDevice",
+ "in": "body",
+ "description": "The resource object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the resource.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDevicePut": {
+ "$ref": "./examples/DataBoxEdgeDevicePut.json"
+ },
+ "DataBoxEdgeDevicePutWithDataResidency": {
+ "$ref": "./examples/DataBoxEdgeDevicePutWithDataResidency.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Deletes the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the resource."
+ },
+ "204": {
+ "description": "The resource is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceDelete": {
+ "$ref": "./examples/DataBoxEdgeDeviceDelete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Modifies a Data Box Edge/Data Box Gateway resource.",
+ "operationId": "Devices_Update",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The resource parameters.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevicePatch"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the resource.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDevicePatch": {
+ "$ref": "./examples/DataBoxEdgeDevicePatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": {
+ "get": {
+ "tags": [
+ "Alerts"
+ ],
+ "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Alerts_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of alerts.",
+ "schema": {
+ "$ref": "#/definitions/AlertList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AlertGetAllInDevice": {
+ "$ref": "./examples/AlertGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": {
+ "get": {
+ "tags": [
+ "Alerts"
+ ],
+ "summary": "Gets an alert by name.",
+ "operationId": "Alerts_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The alert name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The alert details.",
+ "schema": {
+ "$ref": "#/definitions/Alert"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AlertGet": {
+ "$ref": "./examples/AlertGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": {
+ "get": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.",
+ "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of bandwidth schedules.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedulesList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "BandwidthScheduleGetAllInDevice": {
+ "$ref": "./examples/BandwidthScheduleGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": {
+ "get": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Gets the properties of the specified bandwidth schedule.",
+ "operationId": "BandwidthSchedules_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The bandwidth schedule.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "BandwidthScheduleGet": {
+ "$ref": "./examples/BandwidthScheduleGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Creates or updates a bandwidth schedule.",
+ "operationId": "BandwidthSchedules_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name which needs to be added/updated.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The bandwidth schedule to be added or updated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the bandwidth schedule.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the bandwidth schedule."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "BandwidthSchedulePut": {
+ "$ref": "./examples/BandwidthSchedulePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Deletes the specified bandwidth schedule.",
+ "operationId": "BandwidthSchedules_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "202": {
+ "description": "Accepted the request to delete the bandwidth schedule."
+ },
+ "204": {
+ "description": "Successfully deleted the bandwidth schedule."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "BandwidthScheduleDelete": {
+ "$ref": "./examples/BandwidthScheduleDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck": {
+ "post": {
+ "tags": [
+ "DeviceCapacityCheck"
+ ],
+ "description": "Posts the device capacity request info to check feasibility.",
+ "operationId": "DeviceCapacityCheck_CheckResourceCreationFeasibility",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deviceCapacityRequestInfo",
+ "in": "body",
+ "description": "The device capacity request info.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeviceCapacityRequestInfo"
+ }
+ },
+ {
+ "name": "capacityName",
+ "in": "query",
+ "description": "The capacity name.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to check the feasibility of resource creation."
+ },
+ "200": {
+ "description": "Successfully checked the feasibility of resource creation."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "DeviceCapacityRequestPost": {
+ "$ref": "./examples/DeviceCapacityRequestPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default": {
+ "get": {
+ "tags": [
+ "DeviceCapacityInfo"
+ ],
+ "description": "Gets the properties of the specified device capacity info.",
+ "operationId": "DeviceCapacityInfo_GetDeviceCapacityInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The device capacity info result.",
+ "schema": {
+ "$ref": "#/definitions/DeviceCapacityInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DeviceCapacityGet": {
+ "$ref": "./examples/DeviceCapacityGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default": {
+ "get": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The diagnostic proactive log collection settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDiagnosticProactiveLogCollectionSettings": {
+ "$ref": "./examples/GetDiagnosticProactiveLogCollectionSettings.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "proactiveLogCollectionSettings",
+ "in": "body",
+ "description": "The proactive log collection settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the proactive log collection settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to update the proactive log collection settings."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UpdateDiagnosticProactiveLogCollectionSettings": {
+ "$ref": "./examples/UpdateDiagnosticProactiveLogCollectionSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default": {
+ "get": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_GetDiagnosticRemoteSupportSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The diagnostic remote support settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDiagnosticRemoteSupportSettings": {
+ "$ref": "./examples/GetDiagnosticRemoteSupportSettings.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticRemoteSupportSettings",
+ "in": "body",
+ "description": "The diagnostic remote support settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to update the diagnostic remote support settings."
+ },
+ "200": {
+ "description": "Successfully updated the diagnostic remote support settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UpdateDiagnosticRemoteSupportSettings": {
+ "$ref": "./examples/UpdateDiagnosticRemoteSupportSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_DownloadUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully downloaded the updates on the device."
+ },
+ "202": {
+ "description": "Accepted the request to download the updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DownloadUpdatesPost": {
+ "$ref": "./examples/DownloadUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Generates certificate for activation key.",
+ "operationId": "Devices_GenerateCertificate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully generated self signed certificate.",
+ "schema": {
+ "$ref": "#/definitions/GenerateCertResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GenerateCertificate": {
+ "$ref": "./examples/GenerateCertificate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.",
+ "operationId": "Devices_GetExtendedInformation",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The additional information.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExtendedInfoPost": {
+ "$ref": "./examples/ExtendedInfoPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_InstallUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully installed updates on the device."
+ },
+ "202": {
+ "description": "Accepted the request to install updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "InstallUpdatesPost": {
+ "$ref": "./examples/InstallUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": {
+ "get": {
+ "tags": [
+ "Jobs"
+ ],
+ "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Jobs_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The job name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The job details.",
+ "schema": {
+ "$ref": "#/definitions/Job"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "JobsGet": {
+ "$ref": "./examples/JobsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_GetNetworkSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The device network settings.",
+ "schema": {
+ "$ref": "#/definitions/NetworkSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "NetworkSettingsGet": {
+ "$ref": "./examples/NetworkSettingsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": {
+ "get": {
+ "tags": [
+ "Nodes"
+ ],
+ "description": "Gets all the nodes currently configured under this Data Box Edge device",
+ "operationId": "Nodes_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all nodes on the device.",
+ "schema": {
+ "$ref": "#/definitions/NodeList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "NodesGetAllInDevice": {
+ "$ref": "./examples/NodeGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/offers": {
+ "get": {
+ "tags": [
+ "MarketplaceImageOffer"
+ ],
+ "summary": "Returns list of all offers",
+ "operationId": "MarketplaceImageOffer_ListOffers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListOffers is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageOfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListOffers.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": {
+ "get": {
+ "tags": [
+ "OperationsStatus"
+ ],
+ "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "OperationsStatus_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The job name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The job details.",
+ "schema": {
+ "$ref": "#/definitions/Job"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OperationsStatusGet": {
+ "$ref": "./examples/OperationsStatusGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": {
+ "get": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Orders_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists all the orders for the Data Box Edge Device",
+ "schema": {
+ "$ref": "#/definitions/OrderList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGetAllInDevice": {
+ "$ref": "./examples/OrderGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": {
+ "get": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Gets a specific order by name.",
+ "operationId": "Orders_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The order details of a device.",
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/OrderGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Creates or updates an order.",
+ "operationId": "Orders_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The order details of a device.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "order",
+ "in": "body",
+ "description": "The order to be created or updated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the order.",
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the order."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "OrderPut": {
+ "$ref": "./examples/OrderPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Deletes the order related to the device.",
+ "operationId": "Orders_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the order."
+ },
+ "202": {
+ "description": "Accepted the request to delete the order."
+ },
+ "204": {
+ "description": "The order is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "OrderDelete": {
+ "$ref": "./examples/OrderDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode": {
+ "post": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Gets the DCAccess Code",
+ "operationId": "Orders_ListDCAccessCode",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "DC Access code for the device",
+ "schema": {
+ "$ref": "#/definitions/DCAccessCode"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDCAccessCode": {
+ "$ref": "./examples/GetDCAccessCode.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers": {
+ "get": {
+ "tags": [
+ "MarketplaceImagePublisher"
+ ],
+ "summary": "Returns list of publishers",
+ "operationId": "MarketplaceImagePublisher_ListPublishers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListPublishers is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImagePublisherList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListPublishers.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers": {
+ "get": {
+ "tags": [
+ "MarketplaceImageOffer"
+ ],
+ "summary": "Returns List of Offers by Publisher name",
+ "operationId": "MarketplaceImageOffer_ListOffersbyPublisher",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListOffersbyPublisher is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageOfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListOffersbyPublisher.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus": {
+ "get": {
+ "tags": [
+ "MarketplaceImageSku"
+ ],
+ "summary": "Returns List of SKUs Within Offer",
+ "operationId": "MarketplaceImageSku_ListSKUsWithinOffer",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListSKUsWithinOffer is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageSkuList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListSKUsWithinOffer.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions": {
+ "get": {
+ "tags": [
+ "MarketplaceImageVersion"
+ ],
+ "summary": "Returns List of Versions within SKU",
+ "operationId": "MarketplaceImageVersion_ListVersionswithinSKU",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListVersionswithinSKU is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageVersionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListVersionswithinSKU.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}": {
+ "get": {
+ "tags": [
+ "MarketplaceImageVersion"
+ ],
+ "description": "Get Particular Image",
+ "operationId": "MarketplaceImageVersion_GetParticularImage",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "versionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "GetParticularImage is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageVersion"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/GetParticularImage.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}/generatesastoken": {
+ "post": {
+ "tags": [
+ "MarketplaceImageSasToken"
+ ],
+ "summary": "Returns SASToken",
+ "operationId": "MarketplaceImageSasToken_GetSASToken",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "versionName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to start VM Image Download",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceSasToken"
+ },
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "GetSASToken is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceSasToken"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/GetSASToken.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": {
+ "get": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Roles_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of all the roles configured in the device.",
+ "schema": {
+ "$ref": "#/definitions/RoleList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "RoleGetAllInDevice": {
+ "$ref": "./examples/RoleGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": {
+ "get": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Gets a specific role by name.",
+ "operationId": "Roles_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The role with the specified name in the given device.",
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RoleGet": {
+ "$ref": "./examples/RoleGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Create or update a role.",
+ "operationId": "Roles_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "role",
+ "in": "body",
+ "description": "The role properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the role.",
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the role."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RolePut": {
+ "$ref": "./examples/RolePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Deletes the role on the device.",
+ "operationId": "Roles_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the role."
+ },
+ "202": {
+ "description": "Accepted the request to delete the role."
+ },
+ "204": {
+ "description": "The role is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RoleDelete": {
+ "$ref": "./examples/RoleDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons": {
+ "get": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Lists all the addons configured in the role.",
+ "operationId": "Addons_ListByRole",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of all the addons configured in the role.",
+ "schema": {
+ "$ref": "#/definitions/AddonList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "RoleListAddOns": {
+ "$ref": "./examples/RoleListAddOns.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}": {
+ "get": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Gets a specific addon by name.",
+ "operationId": "Addons_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The addon with the specified name in the role.",
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAddOns": {
+ "$ref": "./examples/GetAddons.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Create or update a addon.",
+ "operationId": "Addons_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addon",
+ "in": "body",
+ "description": "The addon properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the addon.",
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the addon."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "PutAddOns": {
+ "$ref": "./examples/PutAddons.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Deletes the addon on the device.",
+ "operationId": "Addons_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the addon."
+ },
+ "202": {
+ "description": "Accepted the request to delete the addon."
+ },
+ "204": {
+ "description": "The addon is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DeleteAddOns": {
+ "$ref": "./examples/DeleteAddons.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig": {
+ "get": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Lists metric configurations in a role.",
+ "operationId": "MonitoringConfig_List",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The monitoring config details.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfigurationList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ListMonitoringConfig": {
+ "$ref": "./examples/ListMonitoringConfig.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default": {
+ "get": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Gets a metric configuration of a role.",
+ "operationId": "MonitoringConfig_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The monitoring config details.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetMonitoringConfig": {
+ "$ref": "./examples/GetMonitoringConfig.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Creates a new metric configuration or updates an existing one for a role.",
+ "operationId": "MonitoringConfig_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "monitoringMetricConfiguration",
+ "in": "body",
+ "description": "The metric configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the metrics configuration.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the metrics configuration."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "PutMonitoringConfig": {
+ "$ref": "./examples/PutMonitoringConfig.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "deletes a new metric configuration for a role.",
+ "operationId": "MonitoringConfig_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the metrics configuration."
+ },
+ "202": {
+ "description": "Accepted the request to delete the metrics configuration."
+ },
+ "204": {
+ "description": "The metrics configuration is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DeleteMonitoringConfig": {
+ "$ref": "./examples/DeleteMonitoringConfig.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_ScanForUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully scanned the device for updates."
+ },
+ "202": {
+ "description": "Accepted the request to scan for updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ScanForUpdatesPost": {
+ "$ref": "./examples/ScanForUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_CreateOrUpdateSecuritySettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "securitySettings",
+ "in": "body",
+ "description": "The security settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SecuritySettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to update the security settings."
+ },
+ "204": {
+ "description": "Updated the security settings."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "CreateOrUpdateSecuritySettings": {
+ "$ref": "./examples/SecuritySettingsUpdatePost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": {
+ "get": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Shares_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the shares on the device.",
+ "schema": {
+ "$ref": "#/definitions/ShareList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ShareGetAllInDevice": {
+ "$ref": "./examples/ShareGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": {
+ "get": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Gets a share by name.",
+ "operationId": "Shares_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The share details.",
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ShareGet": {
+ "$ref": "./examples/ShareGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Creates a new share or updates an existing share on the device.",
+ "operationId": "Shares_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "share",
+ "in": "body",
+ "description": "The share properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the share.",
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the share."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SharePut": {
+ "$ref": "./examples/SharePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Shares"
+ ],
+ "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Shares_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the share."
+ },
+ "202": {
+ "description": "Accepted the request to delete the share."
+ },
+ "204": {
+ "description": "The share is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ShareDelete": {
+ "$ref": "./examples/ShareDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": {
+ "post": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Refreshes the share metadata with the data from the cloud.",
+ "operationId": "Shares_Refresh",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed the share on the device."
+ },
+ "202": {
+ "description": "Accepted the request to refresh the share on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ShareRefreshPost": {
+ "$ref": "./examples/ShareRefreshPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": {
+ "get": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of storage account credentials.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredentialList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SACGetAllInDevice": {
+ "$ref": "./examples/SACGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": {
+ "get": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Gets the properties of the specified storage account credential.",
+ "operationId": "StorageAccountCredentials_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The storage account credential properties.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SACGet": {
+ "$ref": "./examples/SACGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Creates or updates the storage account credential.",
+ "operationId": "StorageAccountCredentials_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountCredential",
+ "in": "body",
+ "description": "The storage account credential.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the storage account credential.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the storage account credential."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SACPut": {
+ "$ref": "./examples/SACPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Deletes the storage account credential.",
+ "operationId": "StorageAccountCredentials_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the storage account credential."
+ },
+ "202": {
+ "description": "Accepted the request to delete the storage account credential."
+ },
+ "204": {
+ "description": "The storage account credential is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SACDelete": {
+ "$ref": "./examples/SACDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": {
+ "get": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccounts_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the StorageAccounts on the device.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "StorageAccountGetAllInDevice": {
+ "$ref": "./examples/StorageAccountGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": {
+ "get": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Gets a StorageAccount by name.",
+ "operationId": "StorageAccounts_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The storage account name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The storage account details.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageAccountGet": {
+ "$ref": "./examples/StorageAccountGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.",
+ "operationId": "StorageAccounts_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The StorageAccount name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccount",
+ "in": "body",
+ "description": "The StorageAccount properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the StorageAccount.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the StorageAccount."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StorageAccountPut": {
+ "$ref": "./examples/StorageAccountPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccounts_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The StorageAccount name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to delete the StorageAccount."
+ },
+ "204": {
+ "description": "The StorageAccount is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StorageAccountDelete": {
+ "$ref": "./examples/StorageAccountDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": {
+ "get": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Containers_ListByStorageAccount",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The storage Account name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the containers on the device.",
+ "schema": {
+ "$ref": "#/definitions/ContainerList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ContainerListAllInDevice": {
+ "$ref": "./examples/ContainerListAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": {
+ "get": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Gets a container by name.",
+ "operationId": "Containers_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The container details.",
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ContainerGet": {
+ "$ref": "./examples/ContainerGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Creates a new container or updates an existing container on the device.",
+ "operationId": "Containers_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "container",
+ "in": "body",
+ "description": "The container properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the container.",
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the container."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerPut": {
+ "$ref": "./examples/ContainerPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Containers"
+ ],
+ "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Containers_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to delete the container."
+ },
+ "204": {
+ "description": "The container is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerDelete": {
+ "$ref": "./examples/ContainerDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": {
+ "post": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Refreshes the container metadata with the data from the cloud.",
+ "operationId": "Containers_Refresh",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed the container on the device."
+ },
+ "202": {
+ "description": "Accepted the request to refresh the container on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerRefresh": {
+ "$ref": "./examples/ContainerRefresh.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": {
+ "get": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Lists all the triggers configured in the device.",
+ "operationId": "Triggers_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List all the triggers configured in the device",
+ "schema": {
+ "$ref": "#/definitions/TriggerList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "TriggerGetAllInDevice": {
+ "$ref": "./examples/TriggerGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": {
+ "get": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Get a specific trigger by name.",
+ "operationId": "Triggers_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The trigger.",
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TriggerGet": {
+ "$ref": "./examples/TriggerGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Creates or updates a trigger.",
+ "operationId": "Triggers_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "Creates or updates a trigger",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "trigger",
+ "in": "body",
+ "description": "The trigger.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the trigger.",
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the trigger."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerPut": {
+ "$ref": "./examples/TriggerPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Deletes the trigger on the gateway device.",
+ "operationId": "Triggers_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the trigger."
+ },
+ "202": {
+ "description": "Accepted the request to delete the trigger."
+ },
+ "204": {
+ "description": "The trigger is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerDelete": {
+ "$ref": "./examples/TriggerDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage": {
+ "post": {
+ "tags": [
+ "SupportPackages"
+ ],
+ "summary": "Triggers support package on the device",
+ "operationId": "SupportPackages_TriggerSupportPackage",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "triggerSupportPackageRequest",
+ "in": "body",
+ "description": "The trigger support package request object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerSupportPackageRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully triggered support package on the device."
+ },
+ "202": {
+ "description": "Accepted the request to trigger support package on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerSupportPackage": {
+ "$ref": "./examples/TriggerSupportPackage.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_UpdateExtendedInformation",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The patch object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoPatch"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Modify additional information.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetUpdateExtendedInfo": {
+ "$ref": "./examples/GetUpdateExtendedInfo.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.",
+ "operationId": "Devices_GetUpdateSummary",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The update summary.",
+ "schema": {
+ "$ref": "#/definitions/UpdateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UpdateSummaryGet": {
+ "$ref": "./examples/UpdateSummaryGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Uploads registration certificate for the device.",
+ "operationId": "Devices_UploadCertificate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The upload certificate request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UploadCertificateRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully uploaded the registration certificate.",
+ "schema": {
+ "$ref": "#/definitions/UploadCertificateResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UploadCertificatePost": {
+ "$ref": "./examples/UploadCertificatePost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Users_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Specify $filter='Type eq ' to filter on user type property",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all users on the device.",
+ "schema": {
+ "$ref": "#/definitions/UserList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "UserGetAllInDevice": {
+ "$ref": "./examples/UserGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Gets the properties of the specified user.",
+ "operationId": "Users_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The user details.",
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UserGet": {
+ "$ref": "./examples/UserGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Users_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "user",
+ "in": "body",
+ "description": "The user details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the user.",
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the user."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UserPut": {
+ "$ref": "./examples/UserPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Deletes the user on a databox edge/gateway device.",
+ "operationId": "Users_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the user."
+ },
+ "202": {
+ "description": "Accepted the request to delete the user."
+ },
+ "204": {
+ "description": "The user is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UserDelete": {
+ "$ref": "./examples/UserDelete.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Addon": {
+ "description": "Role Addon",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Addon type.",
+ "enum": [
+ "IotEdge",
+ "ArcForKubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AddonType",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Addon",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "AddonList": {
+ "description": "Collection of all the Role addon on the Azure Stack Edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The Value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Addon"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Address": {
+ "description": "The shipping address of the customer.",
+ "required": [
+ "country"
+ ],
+ "type": "object",
+ "properties": {
+ "addressLine1": {
+ "description": "The address line1.",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "The address line2.",
+ "type": "string"
+ },
+ "addressLine3": {
+ "description": "The address line3.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code.",
+ "type": "string"
+ },
+ "city": {
+ "description": "The city name.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state name.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country name.",
+ "type": "string"
+ }
+ }
+ },
+ "Alert": {
+ "description": "Alert on the data box edge/gateway device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AlertProperties",
+ "description": "Properties of alert.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Alert",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertErrorDetails": {
+ "description": "Error details for the alert.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "description": "Error code.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorMessage": {
+ "description": "Error Message.",
+ "type": "string",
+ "readOnly": true
+ },
+ "occurrences": {
+ "format": "int32",
+ "description": "Number of occurrences.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertList": {
+ "description": "Collection of alerts.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Alert"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertProperties": {
+ "description": "Properties of alert.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Alert title.",
+ "type": "string",
+ "readOnly": true
+ },
+ "alertType": {
+ "description": "Alert type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "appearedAtDateTime": {
+ "format": "date-time",
+ "description": "UTC time when the alert appeared.",
+ "type": "string",
+ "readOnly": true
+ },
+ "recommendation": {
+ "description": "Alert recommendation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "severity": {
+ "description": "Severity of the alert.",
+ "enum": [
+ "Informational",
+ "Warning",
+ "Critical"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AlertSeverity",
+ "modelAsString": true
+ }
+ },
+ "errorDetails": {
+ "$ref": "#/definitions/AlertErrorDetails",
+ "description": "Error details of the alert.",
+ "readOnly": true
+ },
+ "detailedInformation": {
+ "description": "Alert details.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ArcAddon": {
+ "description": "Arc Addon.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Addon"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ArcAddonProperties",
+ "description": "Properties specific to Arc addon.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "ArcForKubernetes"
+ },
+ "ArcAddonProperties": {
+ "description": "Arc addon properties.",
+ "required": [
+ "subscriptionId",
+ "resourceGroupName",
+ "resourceName",
+ "resourceLocation"
+ ],
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "description": "Arc resource subscription Id",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Arc resource group name",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Arc resource Name",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Arc resource location",
+ "type": "string"
+ },
+ "version": {
+ "description": "Arc resource version",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostPlatform": {
+ "description": "Host OS supported by the Arc addon.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "hostPlatformType": {
+ "description": "Platform where the runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "description": "Addon Provisioning State",
+ "enum": [
+ "Invalid",
+ "Creating",
+ "Created",
+ "Updating",
+ "Reconfiguring",
+ "Failed",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AddonState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ARMBaseModel": {
+ "description": "Represents the base class for all object models.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "AsymmetricEncryptedSecret": {
+ "description": "Represent the secrets intended for encryption with asymmetric key pair.",
+ "required": [
+ "value",
+ "encryptionAlgorithm"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value of the secret.",
+ "type": "string"
+ },
+ "encryptionCertThumbprint": {
+ "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.",
+ "x-ms-secret": true,
+ "type": "string"
+ },
+ "encryptionAlgorithm": {
+ "description": "The algorithm used to encrypt \"Value\".",
+ "enum": [
+ "None",
+ "AES256",
+ "RSAES_PKCS1_v_1_5"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EncryptionAlgorithm",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Authentication": {
+ "description": "Authentication mechanism for IoT devices.",
+ "type": "object",
+ "properties": {
+ "symmetricKey": {
+ "$ref": "#/definitions/SymmetricKey",
+ "description": "Symmetric key for authentication."
+ }
+ }
+ },
+ "AzureContainerInfo": {
+ "description": "Azure container mapping of the endpoint.",
+ "required": [
+ "storageAccountCredentialId",
+ "containerName",
+ "dataFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "storageAccountCredentialId": {
+ "description": "ID of the storage account credential used to access storage.",
+ "type": "string"
+ },
+ "containerName": {
+ "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).",
+ "type": "string"
+ },
+ "dataFormat": {
+ "description": "Storage format used for the file represented by the share.",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AzureFile"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureContainerDataFormat",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "BandwidthSchedule": {
+ "description": "The bandwidth schedule details.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BandwidthScheduleProperties",
+ "description": "The properties of the bandwidth schedule.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of BandwidthSchedule",
+ "readOnly": true
+ }
+ }
+ },
+ "BandwidthScheduleProperties": {
+ "description": "The properties of the bandwidth schedule.",
+ "required": [
+ "start",
+ "stop",
+ "rateInMbps",
+ "days"
+ ],
+ "type": "object",
+ "properties": {
+ "start": {
+ "description": "The start time of the schedule in UTC.",
+ "type": "string"
+ },
+ "stop": {
+ "description": "The stop time of the schedule in UTC.",
+ "type": "string"
+ },
+ "rateInMbps": {
+ "format": "int32",
+ "description": "The bandwidth rate in Mbps.",
+ "type": "integer"
+ },
+ "days": {
+ "description": "The days of the week when this schedule is applicable.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DayOfWeek",
+ "modelAsString": true
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ }
+ },
+ "BandwidthSchedulesList": {
+ "description": "The collection of bandwidth schedules.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of bandwidth schedules.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ClientAccessRight": {
+ "description": "The mapping between a particular client IP and the type of access client has on the NFS share.",
+ "required": [
+ "client",
+ "accessPermission"
+ ],
+ "type": "object",
+ "properties": {
+ "client": {
+ "description": "IP of the client.",
+ "type": "string"
+ },
+ "accessPermission": {
+ "description": "Type of access to be allowed for the client.",
+ "enum": [
+ "NoAccess",
+ "ReadOnly",
+ "ReadWrite"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClientPermissionType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CloudEdgeManagementRole": {
+ "description": "The preview of Virtual Machine Cloud Management from the Azure supports deploying and managing VMs on your Azure Stack Edge device from Azure Portal. \r\nFor more information, refer to: https://docs.microsoft.com/en-us/azure/databox-online/azure-stack-edge-gpu-virtual-machine-overview\r\nBy using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/ for additional details.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CloudEdgeManagementRoleProperties",
+ "description": "Properties specific to CloudEdgeManagementRole role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "CloudEdgeManagement"
+ },
+ "CloudEdgeManagementRoleProperties": {
+ "description": "CloudEdgeManagement Role properties.",
+ "required": [
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "localManagementStatus": {
+ "description": "Local Edge Management Status",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ },
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfile",
+ "description": "Edge Profile of the resource",
+ "readOnly": true
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CloudError": {
+ "description": "An error response from the service.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody",
+ "description": "The error details."
+ }
+ },
+ "x-ms-external": true
+ },
+ "CloudErrorBody": {
+ "description": "An error response from the service.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message describing the error, intended to be suitable for display in a user interface.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of additional details about the error.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-external": true
+ },
+ "ClusterCapacityViewData": {
+ "description": "Cluster Compute Data.",
+ "type": "object",
+ "properties": {
+ "fqdn": {
+ "description": "The FQDN of the cluster.",
+ "type": "string"
+ },
+ "gpuCapacity": {
+ "$ref": "#/definitions/ClusterGpuCapacity",
+ "description": "The cluster's GPU capacity."
+ },
+ "memoryCapacity": {
+ "$ref": "#/definitions/ClusterMemoryCapacity",
+ "description": "The cluster's memory capacity."
+ },
+ "lastRefreshedTime": {
+ "format": "date-time",
+ "description": "The last time at which the ClusterCapacityViewData was set.",
+ "type": "string"
+ },
+ "totalProvisionedNonHpnCores": {
+ "format": "int64",
+ "description": "The total # of vCPUs provisioned by non-HPN VM per appliance.",
+ "type": "integer"
+ }
+ }
+ },
+ "ClusterGpuCapacity": {
+ "description": "Cluster GPU Data.",
+ "type": "object",
+ "properties": {
+ "gpuType": {
+ "description": "The cluster GPU Type.",
+ "type": "string"
+ },
+ "gpuUsedUnitsCount": {
+ "format": "int32",
+ "description": "The used GPU units count in the cluster.",
+ "type": "integer"
+ },
+ "gpuFreeUnitsCount": {
+ "format": "int32",
+ "description": "The free GPU units count in the cluster.",
+ "type": "integer"
+ },
+ "gpuReservedForFailoverUnitsCount": {
+ "format": "int32",
+ "description": "The GPU units count reserved for failover in the cluster.",
+ "type": "integer"
+ },
+ "gpuTotalUnitsCount": {
+ "format": "int32",
+ "description": "The total GPU units count in the cluster.",
+ "type": "integer"
+ }
+ }
+ },
+ "ClusterMemoryCapacity": {
+ "description": "NodeCapacityInfo defines the required information to determine the placement of a VM.",
+ "type": "object",
+ "properties": {
+ "clusterFreeMemoryMb": {
+ "format": "double",
+ "description": "The free memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterUsedMemoryMb": {
+ "format": "double",
+ "description": "The used memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFailoverMemoryMb": {
+ "format": "double",
+ "description": "The failover memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFragmentationMemoryMb": {
+ "format": "double",
+ "description": "The fragmentation memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterHypervReserveMemoryMb": {
+ "format": "double",
+ "description": "The memory reserved for Hyper-V in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterInfraVmMemoryMb": {
+ "format": "double",
+ "description": "The memory of the Infra VM in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterTotalMemoryMb": {
+ "format": "double",
+ "description": "The total memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterNonFailoverVmMb": {
+ "format": "double",
+ "description": "The non-failover memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterMemoryUsedByVmsMb": {
+ "format": "double",
+ "description": "The memory used by VMs in the cluster in MB.",
+ "type": "number"
+ }
+ }
+ },
+ "ClusterStorageViewData": {
+ "description": "Cluster Storage Data.",
+ "type": "object",
+ "properties": {
+ "clusterTotalStorageMb": {
+ "format": "double",
+ "description": "Total storage on the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFreeStorageMb": {
+ "format": "double",
+ "description": "The available or free storage on the cluster in MB.",
+ "type": "number"
+ }
+ }
+ },
+ "CniConfig": {
+ "description": "Cni configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Cni type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Cni version",
+ "type": "string",
+ "readOnly": true
+ },
+ "podSubnet": {
+ "description": "Pod Subnet",
+ "type": "string",
+ "readOnly": true
+ },
+ "serviceSubnet": {
+ "description": "Service subnet",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ComputeResource": {
+ "description": "Compute infrastructure Resource",
+ "required": [
+ "processorCount",
+ "memoryInGB"
+ ],
+ "type": "object",
+ "properties": {
+ "processorCount": {
+ "format": "int32",
+ "description": "Processor count",
+ "type": "integer"
+ },
+ "memoryInGB": {
+ "format": "int64",
+ "description": "Memory in GB",
+ "type": "integer"
+ }
+ }
+ },
+ "ComputeVersionInformation": {
+ "description": "This contains the compute information",
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "description": "Kubernetes Version",
+ "type": "string"
+ },
+ "iotEdgeVersion": {
+ "description": "IOTEdge Version",
+ "type": "string"
+ },
+ "azureArcVersion": {
+ "description": "Azure Arc Version",
+ "type": "string"
+ }
+ }
+ },
+ "ContactDetails": {
+ "description": "Contains all the contact details of the customer.",
+ "required": [
+ "contactPerson",
+ "companyName",
+ "phone",
+ "emailList"
+ ],
+ "type": "object",
+ "properties": {
+ "contactPerson": {
+ "description": "The contact person name.",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "The phone number.",
+ "type": "string"
+ },
+ "emailList": {
+ "description": "The email list.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "Container": {
+ "description": "Represents a container on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ContainerProperties",
+ "description": "The container properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Container",
+ "readOnly": true
+ }
+ }
+ },
+ "ContainerList": {
+ "description": "Collection of all the containers on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of containers.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Container"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ContainerProperties": {
+ "description": "The container properties.",
+ "required": [
+ "dataFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "containerStatus": {
+ "description": "Current status of the container.",
+ "enum": [
+ "OK",
+ "Offline",
+ "Unknown",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ContainerStatus",
+ "modelAsString": true
+ }
+ },
+ "dataFormat": {
+ "description": "DataFormat for Container",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AzureFile"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureContainerDataFormat",
+ "modelAsString": true
+ }
+ },
+ "refreshDetails": {
+ "$ref": "#/definitions/RefreshDetails",
+ "description": "Details of the refresh job on this container.",
+ "readOnly": true
+ },
+ "createdDateTime": {
+ "format": "date-time",
+ "description": "The UTC time when container got created.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevice": {
+ "description": "The Data Box Edge/Gateway device.",
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU type."
+ },
+ "etag": {
+ "description": "The etag for the devices.",
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ },
+ "kind": {
+ "description": "The kind of the device.",
+ "enum": [
+ "AzureDataBoxGateway",
+ "AzureStackEdge",
+ "AzureStackHub",
+ "AzureModularDataCentre"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataBoxEdgeDeviceKind",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "DataBoxEdge Resource",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceProperties",
+ "description": "The properties of the Data Box Edge/Gateway device.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfo": {
+ "description": "The extended Info of the Data Box Edge/Gateway device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties",
+ "description": "The extended info properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of DataBoxEdgeDevice",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfoPatch": {
+ "description": "The Data Box Edge/Gateway device extended info patch.",
+ "type": "object",
+ "properties": {
+ "clientSecretStoreId": {
+ "description": "The Key Vault ARM Id for client secrets",
+ "type": "string"
+ },
+ "clientSecretStoreUrl": {
+ "description": "The url to access the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyName": {
+ "description": "The name for Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyVersion": {
+ "description": "The version of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "syncStatus": {
+ "description": "For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.",
+ "enum": [
+ "KeyVaultSynced",
+ "KeyVaultSyncFailed",
+ "KeyVaultNotConfigured",
+ "KeyVaultSyncPending",
+ "KeyVaultSyncing",
+ "KeyVaultNotSynced"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyVaultSyncStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfoProperties": {
+ "description": "The properties of the Data Box Edge/Gateway device extended info.",
+ "type": "object",
+ "properties": {
+ "encryptionKeyThumbprint": {
+ "description": "The digital signature of encrypted certificate.",
+ "type": "string"
+ },
+ "encryptionKey": {
+ "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.",
+ "type": "string"
+ },
+ "resourceKey": {
+ "description": "The Resource ID of the Resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "clientSecretStoreId": {
+ "description": "The Key Vault ARM Id for client secrets",
+ "type": "string"
+ },
+ "clientSecretStoreUrl": {
+ "description": "The url to access the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyName": {
+ "description": "The name of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyVersion": {
+ "description": "The version of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "keyVaultSyncStatus": {
+ "description": "Key vault sync status",
+ "enum": [
+ "KeyVaultSynced",
+ "KeyVaultSyncFailed",
+ "KeyVaultNotConfigured",
+ "KeyVaultSyncPending",
+ "KeyVaultSyncing",
+ "KeyVaultNotSynced"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyVaultSyncStatus",
+ "modelAsString": true
+ }
+ },
+ "deviceSecrets": {
+ "description": "Device secrets, will be returned only with ODataFilter $expand=deviceSecrets",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/Secret"
+ },
+ "readOnly": true
+ },
+ "clusterWitnessType": {
+ "description": "Cluster Witness Type",
+ "enum": [
+ "None",
+ "Cloud",
+ "FileShare"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ClusterWitnessType",
+ "modelAsString": true
+ }
+ },
+ "fileShareWitnessLocation": {
+ "description": "The witness location of file share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "fileShareWitnessUsername": {
+ "description": "The username of file share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessStorageAccountName": {
+ "description": "The Cloud Witness Storage account name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessContainerName": {
+ "description": "The Container for cloud witness in the storage account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessStorageEndpoint": {
+ "description": "The Azure service endpoint of the cloud witness storage account.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceList": {
+ "description": "The collection of Data Box Edge/Gateway devices.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of Data Box Edge/Gateway devices.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevicePatch": {
+ "description": "The Data Box Edge/Gateway device patch.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags attached to the Data Box Edge/Gateway resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ },
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDevicePropertiesPatch",
+ "description": "The properties associated with the Data Box Edge/Gateway resource",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceProperties": {
+ "description": "The properties of the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "DataBoxEdge Device Properties",
+ "readOnly": true
+ },
+ "dataBoxEdgeDeviceStatus": {
+ "description": "The status of the Data Box Edge/Gateway device.",
+ "enum": [
+ "ReadyToSetup",
+ "Online",
+ "Offline",
+ "NeedsAttention",
+ "Disconnected",
+ "PartiallyDisconnected",
+ "Maintenance"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataBoxEdgeDeviceStatus",
+ "modelAsString": true
+ }
+ },
+ "serialNumber": {
+ "description": "The Serial Number of Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The Description of the Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "modelDescription": {
+ "description": "The description of the Data Box Edge/Gateway device model.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceType": {
+ "description": "The type of the Data Box Edge/Gateway device.",
+ "enum": [
+ "DataBoxEdgeDevice"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DeviceType",
+ "modelAsString": true
+ }
+ },
+ "friendlyName": {
+ "description": "The Data Box Edge/Gateway device name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "culture": {
+ "description": "The Data Box Edge/Gateway device culture.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceModel": {
+ "description": "The Data Box Edge/Gateway device model.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceSoftwareVersion": {
+ "description": "The Data Box Edge/Gateway device software version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceLocalCapacity": {
+ "format": "int64",
+ "description": "The Data Box Edge/Gateway device local capacity in MB.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "timeZone": {
+ "description": "The Data Box Edge/Gateway device timezone.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceHcsVersion": {
+ "description": "The device software version number of the device (eg: 1.2.18105.6).",
+ "type": "string",
+ "readOnly": true
+ },
+ "configuredRoleTypes": {
+ "description": "Type of compute roles configured.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ },
+ "x-ms-identifiers": []
+ },
+ "readOnly": true
+ },
+ "nodeCount": {
+ "format": "int32",
+ "description": "The number of nodes in the cluster.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "resourceMoveDetails": {
+ "$ref": "#/definitions/ResourceMoveDetails",
+ "description": "The details of the move operation on this resource.",
+ "readOnly": true
+ },
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfile",
+ "description": "The details of Edge Profile for this resource",
+ "readOnly": true
+ },
+ "dataResidency": {
+ "$ref": "#/definitions/DataResidency",
+ "description": "The details of data-residency related properties for this resource"
+ },
+ "computeVersionInformation": {
+ "$ref": "#/definitions/ComputeVersionInformation",
+ "description": "The details of compute version information",
+ "readOnly": true
+ },
+ "kubernetesPlatform": {
+ "description": "Type of Kubernetes Platform",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevicePropertiesPatch": {
+ "description": "The Data Box Edge/Gateway device properties patch.",
+ "type": "object",
+ "properties": {
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfilePatch",
+ "description": "Edge Profile property of the Data Box Edge/Gateway device"
+ }
+ }
+ },
+ "DataBoxEdgeMoveRequest": {
+ "description": "Resource Move details",
+ "required": [
+ "targetResourceGroup",
+ "resources"
+ ],
+ "type": "object",
+ "properties": {
+ "targetResourceGroup": {
+ "description": "Target resource group ARMId",
+ "type": "string"
+ },
+ "resources": {
+ "description": "List of resources to be moved",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "DataBoxEdgeSku": {
+ "description": "The Sku information.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The Sku name.",
+ "enum": [
+ "Gateway",
+ "Edge",
+ "TEA_1Node",
+ "TEA_1Node_UPS",
+ "TEA_1Node_Heater",
+ "TEA_1Node_UPS_Heater",
+ "TEA_4Node_Heater",
+ "TEA_4Node_UPS_Heater",
+ "TMA",
+ "TDC",
+ "TCA_Small",
+ "GPU",
+ "TCA_Large",
+ "EdgeP_Base",
+ "EdgeP_High",
+ "EdgePR_Base",
+ "EdgePR_Base_UPS",
+ "EP2_64_1VPU_W",
+ "EP2_128_1T4_Mx1_W",
+ "EP2_256_2T4_W",
+ "EdgeMR_Mini",
+ "RCA_Small",
+ "RCA_Large",
+ "RDC",
+ "Management",
+ "EP2_64_Mx1_W",
+ "EP2_128_GPU1_Mx1_W",
+ "EP2_256_GPU2_Mx1",
+ "EdgeMR_TCP"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "kind": {
+ "description": "The Sku kind.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tier": {
+ "description": "The Sku tier.",
+ "enum": [
+ "Standard"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ },
+ "size": {
+ "description": "The Sku kind.",
+ "type": "string",
+ "readOnly": true
+ },
+ "family": {
+ "description": "The Sku family.",
+ "type": "string",
+ "readOnly": true
+ },
+ "locations": {
+ "description": "Availability of the Sku for the region.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "apiVersions": {
+ "description": "The API versions in which Sku is available.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "locationInfo": {
+ "description": "Availability of the Sku for the location/zone/site.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuLocationInfo"
+ },
+ "x-ms-identifiers": [
+ "location"
+ ],
+ "readOnly": true
+ },
+ "costs": {
+ "description": "The pricing info of the Sku.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCost"
+ },
+ "x-ms-identifiers": [
+ "meterId"
+ ],
+ "readOnly": true
+ },
+ "signupOption": {
+ "description": "Sku can be signed up by customer or not.",
+ "enum": [
+ "None",
+ "Available"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuSignupOption",
+ "modelAsString": true
+ }
+ },
+ "version": {
+ "description": "Availability of the Sku as preview/stable.",
+ "enum": [
+ "Stable",
+ "Preview"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuVersion",
+ "modelAsString": true
+ }
+ },
+ "availability": {
+ "description": "Links to the next set of results",
+ "enum": [
+ "Available",
+ "Unavailable"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuAvailability",
+ "modelAsString": true
+ }
+ },
+ "shipmentTypes": {
+ "description": "List of Shipment Types supported by this SKU",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "NotApplicable",
+ "ShippedToCustomer",
+ "SelfPickup"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShipmentType",
+ "modelAsString": true
+ }
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "capabilities": {
+ "description": "The capability info of the SKU.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCapability"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeSkuList": {
+ "description": "List of SKU Information objects.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of ResourceType Sku",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxEdgeSku"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "resourceType"
+ ],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Links to the next set of results",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataResidency": {
+ "description": "Wraps data-residency related information for edge-resource and this should be used with ARM layer.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "DataResidencyType enum",
+ "enum": [
+ "GeoZoneReplication",
+ "ZoneReplication"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DCAccessCode": {
+ "description": "DC Access code in the case of Self Managed Shipping.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DCAccessCodeProperties",
+ "description": "DCAccessCode properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DCAccessCodeProperties": {
+ "description": "DCAccessCode Properties.",
+ "type": "object",
+ "properties": {
+ "authCode": {
+ "description": "DCAccess Code for the Self Managed shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "DeviceCapacityInfo": {
+ "description": "Object for Capturing DeviceCapacityInfo",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeviceCapacityInfoProperties",
+ "description": "The device capacity properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to device capacity info.",
+ "readOnly": true
+ }
+ }
+ },
+ "DeviceCapacityInfoProperties": {
+ "description": "The properties of Device Capacity Info",
+ "type": "object",
+ "properties": {
+ "timeStamp": {
+ "format": "date-time",
+ "description": "Timestamp of request in UTC",
+ "type": "string"
+ },
+ "clusterStorageCapacityInfo": {
+ "$ref": "#/definitions/ClusterStorageViewData",
+ "description": "Cluster capacity data for storage resources (CSV)."
+ },
+ "clusterComputeCapacityInfo": {
+ "$ref": "#/definitions/ClusterCapacityViewData",
+ "description": "Cluster capacity data for compute resources (Memory and GPU)."
+ },
+ "nodeCapacityInfos": {
+ "description": "The dictionary of individual node names and node capacities in the cluster.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/HostCapacity"
+ }
+ }
+ }
+ },
+ "DeviceCapacityRequestInfo": {
+ "description": "Object for Capturing DeviceCapacityRequestInfo",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeviceCapacityRequestInfoProperties",
+ "description": "The properties of the Device Capacity Request.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DeviceCapacityRequestInfoProperties": {
+ "description": "Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.",
+ "required": [
+ "vmPlacementQuery"
+ ],
+ "type": "object",
+ "properties": {
+ "vmPlacementQuery": {
+ "description": "Array containing the sizes of the VMs for checking if its feasible to create them on the appliance.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "x-ms-identifiers": []
+ },
+ "vmPlacementResults": {
+ "description": "Array of the VMs of the sizes in VmSizes can be provisioned on the appliance.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VmPlacementRequestResult"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "DiagnosticProactiveLogCollectionSettings": {
+ "description": "The diagnostic proactive log collection settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ProactiveLogCollectionSettingsProperties",
+ "description": "Properties of the diagnostic proactive log collection settings.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticRemoteSupportSettings": {
+ "description": "The remote support settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettingsProperties",
+ "description": "Properties of the remote support settings.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Represents resource creation and updation time",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticRemoteSupportSettingsProperties": {
+ "description": "The properties of remote support settings.",
+ "type": "object",
+ "properties": {
+ "remoteSupportSettingsList": {
+ "description": "Remote support settings list according to the RemoteApplicationType",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RemoteSupportSettings"
+ },
+ "x-ms-identifiers": [
+ "remoteApplicationType"
+ ]
+ }
+ }
+ },
+ "EdgeProfile": {
+ "description": "Details about Edge Profile for the resource",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "$ref": "#/definitions/EdgeProfileSubscription",
+ "description": "Edge Profile Subscription"
+ }
+ }
+ },
+ "EdgeProfilePatch": {
+ "description": "The Data Box Edge/Gateway Edge Profile patch.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "$ref": "#/definitions/EdgeProfileSubscriptionPatch",
+ "description": "The Data Box Edge/Gateway Edge Profile Subscription patch"
+ }
+ }
+ },
+ "EdgeProfileSubscription": {
+ "description": "Subscription details for the Edge Profile",
+ "type": "object",
+ "properties": {
+ "registrationId": {
+ "description": "Edge Subscription Registration ID",
+ "type": "string"
+ },
+ "id": {
+ "description": "ARM ID of the subscription",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "Registered",
+ "Warned",
+ "Suspended",
+ "Deleted",
+ "Unregistered"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SubscriptionState",
+ "modelAsString": true
+ }
+ },
+ "registrationDate": {
+ "type": "string"
+ },
+ "subscriptionId": {
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/SubscriptionProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "EdgeProfileSubscriptionPatch": {
+ "description": "The Data Box Edge/Gateway Edge Profile Subscription patch.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the subscription of the edge profile.",
+ "type": "string"
+ }
+ }
+ },
+ "EtcdInfo": {
+ "description": "Etcd configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Etcd type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Etcd version",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "FileEventTrigger": {
+ "description": "Trigger details.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Trigger"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/FileTriggerProperties",
+ "description": "File trigger properties.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "FileEvent"
+ },
+ "FileSourceInfo": {
+ "description": "File source details.",
+ "required": [
+ "shareId"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "File share ID.",
+ "type": "string"
+ }
+ }
+ },
+ "FileTriggerProperties": {
+ "description": "File trigger properties.",
+ "required": [
+ "sourceInfo",
+ "sinkInfo"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceInfo": {
+ "$ref": "#/definitions/FileSourceInfo",
+ "description": "File event source details."
+ },
+ "sinkInfo": {
+ "$ref": "#/definitions/RoleSinkInfo",
+ "description": "Role sink info."
+ },
+ "customContextTag": {
+ "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
+ "maxLength": 192,
+ "type": "string"
+ }
+ }
+ },
+ "GenerateCertResponse": {
+ "description": "Used in activation key generation flow.",
+ "type": "object",
+ "properties": {
+ "publicKey": {
+ "description": "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "expiryTimeInUTC": {
+ "description": "Gets or sets expiry time in UTC",
+ "type": "string"
+ }
+ }
+ },
+ "HostCapacity": {
+ "description": "Host Capacity Data.",
+ "type": "object",
+ "properties": {
+ "hostName": {
+ "description": "The name of the host.",
+ "type": "string"
+ },
+ "effectiveAvailableMemoryMbOnHost": {
+ "format": "int64",
+ "description": "The available memory on the host accounting for VM placement size and any host VM reservations.",
+ "type": "integer"
+ },
+ "availableGpuCount": {
+ "format": "int32",
+ "description": "The available amount of GPUs on the host to use after accounting for GPUS used by reservations on the host.",
+ "type": "integer"
+ },
+ "vmUsedMemory": {
+ "description": "The VM used memory per VmId.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/VmMemory"
+ }
+ },
+ "gpuType": {
+ "description": "The GPU type of the VM.",
+ "type": "string"
+ },
+ "numaNodesData": {
+ "description": "The numa nodes information for Hpn VMs.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NumaNodeData"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ImageRepositoryCredential": {
+ "description": "Image repository credential.",
+ "required": [
+ "imageRepositoryUrl",
+ "userName"
+ ],
+ "type": "object",
+ "properties": {
+ "imageRepositoryUrl": {
+ "description": "Image repository url (e.g.: mcr.microsoft.com).",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Repository user name.",
+ "type": "string"
+ },
+ "password": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Repository user password."
+ }
+ }
+ },
+ "IoTDeviceInfo": {
+ "description": "Metadata of IoT device/IoT Edge device to be configured.",
+ "required": [
+ "deviceId",
+ "ioTHostHub"
+ ],
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "ID of the IoT device/edge device.",
+ "type": "string"
+ },
+ "ioTHostHub": {
+ "description": "Host name for the IoT hub associated to the device.",
+ "type": "string"
+ },
+ "ioTHostHubId": {
+ "description": "Id for the IoT hub associated to the device.",
+ "type": "string"
+ },
+ "authentication": {
+ "$ref": "#/definitions/Authentication",
+ "description": "Encrypted IoT device/IoT edge device connection string."
+ }
+ }
+ },
+ "IoTEdgeAgentInfo": {
+ "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.",
+ "required": [
+ "imageName",
+ "tag"
+ ],
+ "type": "object",
+ "properties": {
+ "imageName": {
+ "description": "Name of the IoT edge agent image.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Image Tag.",
+ "type": "string"
+ },
+ "imageRepository": {
+ "$ref": "#/definitions/ImageRepositoryCredential",
+ "description": "Image repository details."
+ }
+ }
+ },
+ "IoTRole": {
+ "description": "Compute role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/IoTRoleProperties",
+ "description": "Properties specific to IoT role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "IOT"
+ },
+ "IoTRoleProperties": {
+ "description": "IoT role properties.",
+ "required": [
+ "hostPlatform",
+ "ioTDeviceDetails",
+ "ioTEdgeDeviceDetails",
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "hostPlatform": {
+ "description": "Host OS supported by the IoT role.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "ioTDeviceDetails": {
+ "$ref": "#/definitions/IoTDeviceInfo",
+ "description": "IoT device metadata to which data box edge device needs to be connected."
+ },
+ "ioTEdgeDeviceDetails": {
+ "$ref": "#/definitions/IoTDeviceInfo",
+ "description": "IoT edge device to which the IoT role needs to be configured."
+ },
+ "shareMappings": {
+ "description": "Mount points of shares in role(s).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ]
+ },
+ "ioTEdgeAgentInfo": {
+ "$ref": "#/definitions/IoTEdgeAgentInfo",
+ "description": "Iot edge agent details to download the agent and bootstrap iot runtime."
+ },
+ "hostPlatformType": {
+ "description": "Platform where the Iot runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "computeResource": {
+ "$ref": "#/definitions/ComputeResource",
+ "description": "Resource allocation"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Ipv4Config": {
+ "description": "Details related to the IPv4 address configuration.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IPv4 address of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subnet": {
+ "description": "The IPv4 subnet of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "gateway": {
+ "description": "The IPv4 gateway of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Ipv6Config": {
+ "description": "Details related to the IPv6 address configuration.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IPv6 address of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "prefixLength": {
+ "format": "int32",
+ "description": "The IPv6 prefix of the network adapter.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "gateway": {
+ "description": "The IPv6 gateway of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Job": {
+ "description": "A device job.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The current status of the job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "The UTC date and time at which the job started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "The UTC date and time at which the job completed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "percentComplete": {
+ "format": "int32",
+ "description": "The percentage of the job that is complete.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "error": {
+ "$ref": "#/definitions/JobErrorDetails",
+ "description": "The error details.",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/JobProperties",
+ "description": "The properties of the job.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "JobErrorDetails": {
+ "description": "The job error information containing the list of job errors.",
+ "type": "object",
+ "properties": {
+ "errorDetails": {
+ "description": "The error details.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/JobErrorItem"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "code": {
+ "description": "The code intended for programmatic access.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The message that describes the error in detail.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "JobErrorItem": {
+ "description": "The job error items.",
+ "type": "object",
+ "properties": {
+ "recommendations": {
+ "description": "The recommended actions.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "code": {
+ "description": "The code intended for programmatic access.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The message that describes the error in detail.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "JobProperties": {
+ "description": "The properties for the job.",
+ "type": "object",
+ "properties": {
+ "jobType": {
+ "description": "The type of the job.",
+ "enum": [
+ "Invalid",
+ "ScanForUpdates",
+ "DownloadUpdates",
+ "InstallUpdates",
+ "RefreshShare",
+ "RefreshContainer",
+ "Backup",
+ "Restore",
+ "TriggerSupportPackage"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobType",
+ "modelAsString": true
+ }
+ },
+ "currentStage": {
+ "description": "Current stage of the update operation.",
+ "enum": [
+ "Unknown",
+ "Initial",
+ "ScanStarted",
+ "ScanComplete",
+ "ScanFailed",
+ "DownloadStarted",
+ "DownloadComplete",
+ "DownloadFailed",
+ "InstallStarted",
+ "InstallComplete",
+ "InstallFailed",
+ "RebootInitiated",
+ "Success",
+ "Failure",
+ "RescanStarted",
+ "RescanComplete",
+ "RescanFailed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "UpdateOperationStage",
+ "modelAsString": true
+ }
+ },
+ "downloadProgress": {
+ "$ref": "#/definitions/UpdateDownloadProgress",
+ "description": "The download progress.",
+ "readOnly": true
+ },
+ "installProgress": {
+ "$ref": "#/definitions/UpdateInstallProgress",
+ "description": "The install progress.",
+ "readOnly": true
+ },
+ "totalRefreshErrors": {
+ "format": "int32",
+ "description": "Total number of errors encountered during the refresh process.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "errorManifestFile": {
+ "description": "Local share/remote container relative path to the error manifest file of the refresh.",
+ "type": "string",
+ "readOnly": true
+ },
+ "refreshedEntityId": {
+ "description": "ARM ID of the entity that was refreshed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "folder": {
+ "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)",
+ "type": "string"
+ }
+ }
+ },
+ "KubernetesClusterInfo": {
+ "description": "Kubernetes cluster configuration",
+ "required": [
+ "version"
+ ],
+ "type": "object",
+ "properties": {
+ "etcdInfo": {
+ "$ref": "#/definitions/EtcdInfo",
+ "description": "Etcd configuration",
+ "readOnly": true
+ },
+ "nodes": {
+ "description": "Kubernetes cluster nodes",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeInfo"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "readOnly": true
+ },
+ "version": {
+ "description": "Kubernetes cluster version",
+ "type": "string"
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KubernetesIPConfiguration": {
+ "description": "Kubernetes node IP configuration",
+ "type": "object",
+ "properties": {
+ "port": {
+ "description": "Port of the Kubernetes node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "ipAddress": {
+ "description": "IP address of the Kubernetes node.",
+ "type": "string"
+ }
+ }
+ },
+ "KubernetesRole": {
+ "description": "The limited preview of Kubernetes Cluster Management from the Azure supports:\r\n1. Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device. \r\n2. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. \r\n Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs.\r\n3. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. \r\n For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf \r\n Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4\r\n By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/KubernetesRoleProperties",
+ "description": "Properties specific to Kubernetes role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "Kubernetes"
+ },
+ "KubernetesRoleCompute": {
+ "description": "Kubernetes role compute resource",
+ "required": [
+ "vmProfile"
+ ],
+ "type": "object",
+ "properties": {
+ "vmProfile": {
+ "description": "VM profile",
+ "type": "string"
+ },
+ "memoryInBytes": {
+ "format": "int64",
+ "description": "Memory in bytes",
+ "type": "integer",
+ "readOnly": true
+ },
+ "processorCount": {
+ "format": "int32",
+ "description": "Processor count",
+ "type": "integer",
+ "readOnly": true
+ },
+ "hugePage2M": {
+ "format": "int32",
+ "description": "Count of huge pages",
+ "type": "integer",
+ "readOnly": true
+ },
+ "hugePage1G": {
+ "format": "int32",
+ "description": "Count of huge pages",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleNetwork": {
+ "description": "Kubernetes role network resource",
+ "type": "object",
+ "properties": {
+ "cniConfig": {
+ "$ref": "#/definitions/CniConfig",
+ "description": "Cni configuration",
+ "readOnly": true
+ },
+ "loadBalancerConfig": {
+ "$ref": "#/definitions/LoadBalancerConfig",
+ "description": "Load balancer configuration",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleProperties": {
+ "description": "Kubernetes role properties.",
+ "required": [
+ "hostPlatform",
+ "kubernetesClusterInfo",
+ "kubernetesRoleResources",
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "hostPlatform": {
+ "description": "Host OS supported by the Kubernetes role.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "description": "State of Kubernetes deployment",
+ "enum": [
+ "Invalid",
+ "Creating",
+ "Created",
+ "Updating",
+ "Reconfiguring",
+ "Failed",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesState",
+ "modelAsString": true
+ }
+ },
+ "hostPlatformType": {
+ "description": "Platform where the runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "kubernetesClusterInfo": {
+ "$ref": "#/definitions/KubernetesClusterInfo",
+ "description": "Kubernetes cluster configuration"
+ },
+ "kubernetesRoleResources": {
+ "$ref": "#/definitions/KubernetesRoleResources",
+ "description": "Kubernetes role resources"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KubernetesRoleResources": {
+ "description": "Kubernetes role resources",
+ "required": [
+ "compute"
+ ],
+ "type": "object",
+ "properties": {
+ "storage": {
+ "$ref": "#/definitions/KubernetesRoleStorage",
+ "description": "Kubernetes role storage resource"
+ },
+ "compute": {
+ "$ref": "#/definitions/KubernetesRoleCompute",
+ "description": "Kubernetes role compute resource"
+ },
+ "network": {
+ "$ref": "#/definitions/KubernetesRoleNetwork",
+ "description": "Kubernetes role network resource",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleStorage": {
+ "description": "Kubernetes role storage resource",
+ "type": "object",
+ "properties": {
+ "storageClasses": {
+ "description": "Kubernetes storage class info.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/KubernetesRoleStorageClassInfo"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "readOnly": true
+ },
+ "endpoints": {
+ "description": "Mount points of shares in role(s).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ]
+ }
+ }
+ },
+ "KubernetesRoleStorageClassInfo": {
+ "description": "Kubernetes storage class info.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Storage class name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Storage class type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "posixCompliant": {
+ "description": "If provisioned storage is posix compliant.",
+ "enum": [
+ "Invalid",
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PosixComplianceStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "LoadBalancerConfig": {
+ "description": "Load balancer configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Load balancer type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Load balancer version",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "MarketplaceImageOffer": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageOfferProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageOfferList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageOffer"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageOfferProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "provisioningState": {
+ "type": "string"
+ },
+ "skuMappings": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuMapping"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MarketplaceImagePublisher": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImagePublisherProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImagePublisherList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImagePublisher"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImagePublisherProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceImageSku": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageSkuProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageSkuList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageSku"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageSkuProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "offerId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "skuMappings": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuMapping"
+ },
+ "x-ms-identifiers": []
+ },
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceImageVersion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageVersionProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageVersionList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageVersion"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageVersionProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "offerId": {
+ "type": "string"
+ },
+ "skuId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceSasToken": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "sasUri": {
+ "type": "string",
+ "x-ms-secret": true
+ }
+ }
+ },
+ "MECRole": {
+ "description": "MEC role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MECRoleProperties",
+ "description": "Properties specific to MEC role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "MEC"
+ },
+ "MECRoleProperties": {
+ "description": "MEC role properties.",
+ "required": [
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "connectionString": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Activation key of the MEC."
+ },
+ "controllerEndpoint": {
+ "description": "Controller Endpoint.",
+ "type": "string"
+ },
+ "resourceUniqueId": {
+ "description": "Unique Id of the Resource.",
+ "type": "string"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "MetricConfiguration": {
+ "description": "Metric configuration.",
+ "required": [
+ "resourceId",
+ "counterSets"
+ ],
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Resource ID on which the metrics should be pushed.",
+ "type": "string"
+ },
+ "mdmAccount": {
+ "description": "The MDM account to which the counters should be pushed.",
+ "type": "string"
+ },
+ "metricNameSpace": {
+ "description": "The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified",
+ "type": "string"
+ },
+ "counterSets": {
+ "description": "Host name for the IoT hub associated to the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricCounterSet"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MetricCounter": {
+ "description": "The metric counter",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The counter name.",
+ "type": "string"
+ },
+ "instance": {
+ "description": "The instance from which counter should be collected.",
+ "type": "string"
+ },
+ "dimensionFilter": {
+ "description": "The dimension filter.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension"
+ },
+ "x-ms-identifiers": [
+ "sourceName"
+ ]
+ },
+ "additionalDimensions": {
+ "description": "The additional dimensions to be added to metric.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension"
+ },
+ "x-ms-identifiers": [
+ "sourceName"
+ ]
+ }
+ }
+ },
+ "MetricCounterSet": {
+ "description": "The metric counter set",
+ "required": [
+ "counters"
+ ],
+ "type": "object",
+ "properties": {
+ "counters": {
+ "description": "The counters that should be collected in this set.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricCounter"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "MetricDimension": {
+ "description": "The metric dimension",
+ "required": [
+ "sourceType",
+ "sourceName"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceType": {
+ "description": "The dimension type.",
+ "type": "string"
+ },
+ "sourceName": {
+ "description": "The dimension value.",
+ "type": "string"
+ }
+ }
+ },
+ "MetricDimension_V1": {
+ "description": "Metric Dimension v1.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metrics dimension.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Display name of the metrics dimension.",
+ "type": "string"
+ },
+ "toBeExportedForShoebox": {
+ "description": "To be exported to shoe box.",
+ "type": "boolean"
+ }
+ }
+ },
+ "MetricSpecification_V1": {
+ "description": "Metric specification version 1.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metric.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Display name of the metric.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "Description of the metric to be displayed.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Metric units.",
+ "enum": [
+ "NotSpecified",
+ "Percent",
+ "Count",
+ "Seconds",
+ "Milliseconds",
+ "Bytes",
+ "BytesPerSecond",
+ "CountPerSecond"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricUnit",
+ "modelAsString": true
+ }
+ },
+ "aggregationType": {
+ "description": "Metric aggregation type.",
+ "enum": [
+ "NotSpecified",
+ "None",
+ "Average",
+ "Minimum",
+ "Maximum",
+ "Total",
+ "Count"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricAggregationType",
+ "modelAsString": true
+ }
+ },
+ "dimensions": {
+ "description": "Metric dimensions, other than default dimension which is resource.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension_V1"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "fillGapWithZero": {
+ "description": "Set true to fill the gaps with zero.",
+ "type": "boolean"
+ },
+ "category": {
+ "description": "Metric category.",
+ "enum": [
+ "Capacity",
+ "Transaction"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricCategory",
+ "modelAsString": true
+ }
+ },
+ "resourceIdDimensionNameOverride": {
+ "description": "Resource name override.",
+ "type": "string"
+ },
+ "supportedTimeGrainTypes": {
+ "description": "Support granularity of metrics.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "PT1M",
+ "PT5M",
+ "PT15M",
+ "PT30M",
+ "PT1H",
+ "PT6H",
+ "PT12H",
+ "PT1D"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TimeGrain",
+ "modelAsString": true
+ }
+ }
+ },
+ "supportedAggregationTypes": {
+ "description": "Support metric aggregation type.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "NotSpecified",
+ "None",
+ "Average",
+ "Minimum",
+ "Maximum",
+ "Total",
+ "Count"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricAggregationType",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "MonitoringMetricConfiguration": {
+ "description": "The metric setting details for the role",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MonitoringMetricConfigurationProperties",
+ "description": "The metric setting properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of MonitoringConfiguration",
+ "readOnly": true
+ }
+ }
+ },
+ "MonitoringMetricConfigurationList": {
+ "description": "Collection of metric configurations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of metric configurations.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MonitoringMetricConfigurationProperties": {
+ "description": "Metrics properties",
+ "required": [
+ "metricConfigurations"
+ ],
+ "type": "object",
+ "properties": {
+ "metricConfigurations": {
+ "description": "The metrics configuration details",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricConfiguration"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MountPointMap": {
+ "description": "The share mount point.",
+ "required": [
+ "shareId"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "ID of the share mounted to the role VM.",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "ID of the role to which share is mounted.",
+ "type": "string",
+ "readOnly": true
+ },
+ "mountPoint": {
+ "description": "Mount point for the share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "mountType": {
+ "description": "Mounting type.",
+ "enum": [
+ "Volume",
+ "HostPath"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "MountType",
+ "modelAsString": true
+ }
+ },
+ "roleType": {
+ "description": "Role type.",
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "NetworkAdapter": {
+ "description": "Represents the networkAdapter on a device.",
+ "type": "object",
+ "properties": {
+ "adapterId": {
+ "description": "Instance ID of network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "adapterPosition": {
+ "$ref": "#/definitions/NetworkAdapterPosition",
+ "description": "Hardware position of network adapter.",
+ "readOnly": true
+ },
+ "index": {
+ "format": "int32",
+ "description": "Logical index of the adapter.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "nodeId": {
+ "description": "Node ID of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "networkAdapterName": {
+ "description": "Network adapter name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "label": {
+ "description": "Hardware label for the adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "macAddress": {
+ "description": "MAC address.",
+ "type": "string",
+ "readOnly": true
+ },
+ "linkSpeed": {
+ "format": "int64",
+ "description": "Link speed.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "status": {
+ "description": "Value indicating whether this adapter is valid.",
+ "enum": [
+ "Inactive",
+ "Active"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NetworkAdapterStatus",
+ "modelAsString": true
+ }
+ },
+ "rdmaStatus": {
+ "description": "Value indicating whether this adapter is RDMA capable.",
+ "enum": [
+ "Incapable",
+ "Capable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkAdapterRDMAStatus",
+ "modelAsString": true
+ }
+ },
+ "dhcpStatus": {
+ "description": "Value indicating whether this adapter has DHCP enabled.",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkAdapterDHCPStatus",
+ "modelAsString": true
+ }
+ },
+ "ipv4Configuration": {
+ "$ref": "#/definitions/Ipv4Config",
+ "description": "The IPv4 configuration of the network adapter.",
+ "readOnly": true
+ },
+ "ipv6Configuration": {
+ "$ref": "#/definitions/Ipv6Config",
+ "description": "The IPv6 configuration of the network adapter.",
+ "readOnly": true
+ },
+ "ipv6LinkLocalAddress": {
+ "description": "The IPv6 local address.",
+ "type": "string",
+ "readOnly": true
+ },
+ "dnsServers": {
+ "description": "The list of DNS Servers of the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "NetworkAdapterPosition": {
+ "description": "The network adapter position.",
+ "type": "object",
+ "properties": {
+ "networkGroup": {
+ "description": "The network group.",
+ "enum": [
+ "None",
+ "NonRDMA",
+ "RDMA"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NetworkGroup",
+ "modelAsString": true
+ }
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "NetworkSettings": {
+ "description": "The network settings of a device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/NetworkSettingsProperties",
+ "description": "The properties of network settings of a device.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of NetworkSettings",
+ "readOnly": true
+ }
+ }
+ },
+ "NetworkSettingsProperties": {
+ "description": "The properties of network settings.",
+ "type": "object",
+ "properties": {
+ "networkAdapters": {
+ "description": "The network adapter list on the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkAdapter"
+ },
+ "x-ms-identifiers": [
+ "adapterId"
+ ],
+ "readOnly": true
+ }
+ }
+ },
+ "Node": {
+ "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/NodeProperties",
+ "description": "The properties of the node",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "NodeInfo": {
+ "description": "Kubernetes node info",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Node name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Node type - Master/Worker",
+ "enum": [
+ "Invalid",
+ "Master",
+ "Worker",
+ "ManagementCluster",
+ "ControlPlane",
+ "NodePool"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesNodeType",
+ "modelAsString": true
+ }
+ },
+ "ipConfiguration": {
+ "description": "IP Configuration of the Kubernetes node.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/KubernetesIPConfiguration"
+ },
+ "x-ms-identifiers": [
+ "ipAddress",
+ "port"
+ ]
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "NodeList": {
+ "description": "Collection of Nodes.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of Nodes.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Node"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "NodeProperties": {
+ "description": "This class represents the nodes in a highly available cluster",
+ "type": "object",
+ "properties": {
+ "nodeStatus": {
+ "description": "The current status of the individual node",
+ "enum": [
+ "Unknown",
+ "Up",
+ "Down",
+ "Rebooting",
+ "ShuttingDown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NodeStatus",
+ "modelAsString": true
+ }
+ },
+ "nodeChassisSerialNumber": {
+ "description": "Serial number of the Chassis",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeSerialNumber": {
+ "description": "Serial number of the individual node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeDisplayName": {
+ "description": "Display Name of the individual node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeFriendlySoftwareVersion": {
+ "description": "Friendly software version name that is currently installed on the node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeHcsVersion": {
+ "description": "HCS version that is currently installed on the node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeInstanceId": {
+ "description": "Guid instance id of the node",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "NumaNodeData": {
+ "description": "NUMA node data.",
+ "type": "object",
+ "properties": {
+ "numaNodeIndex": {
+ "format": "int32",
+ "description": "The NUMA node index.",
+ "type": "integer"
+ },
+ "totalMemoryInMb": {
+ "format": "int64",
+ "description": "The total memory on the NUMA node.",
+ "type": "integer"
+ },
+ "logicalCoreCountPerCore": {
+ "format": "int32",
+ "description": "The logical cores per core count.",
+ "type": "integer"
+ },
+ "effectiveAvailableMemoryInMb": {
+ "format": "int64",
+ "description": "The effective available memory on the NUMA node in MB.",
+ "type": "integer"
+ },
+ "freeVCpuIndexesForHpn": {
+ "description": "The free VCPU indices for the Hpn VMs.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "vCpuIndexesForHpn": {
+ "description": "The VCPU indices for Hpn VMs",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "vCpuIndexesForRoot": {
+ "description": "The VCPU indices for the root.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "Operation": {
+ "description": "Operations.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Is data action.",
+ "type": "boolean"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay",
+ "description": "Properties displayed for the operation."
+ },
+ "origin": {
+ "description": "Origin of the operation.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Operation properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "Operation display properties.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Provider name.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "The type of resource in which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation to be performed on the resource.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation to be performed.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Operation properties.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ServiceSpecification",
+ "description": "Service specification."
+ }
+ }
+ },
+ "OperationsList": {
+ "description": "The list of operations used for the discovery of available provider operations.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string"
+ }
+ }
+ },
+ "Order": {
+ "description": "The order details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "It specify the order api version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Order",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/OrderProperties",
+ "description": "The order properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OrderList": {
+ "description": "List of order entities.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of orders.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Order"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "OrderProperties": {
+ "description": "Order properties.",
+ "type": "object",
+ "required": [
+ "contactInformation"
+ ],
+ "properties": {
+ "orderId": {
+ "description": "It specify the order resource id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "contactInformation": {
+ "$ref": "#/definitions/ContactDetails",
+ "description": "The contact details."
+ },
+ "shippingAddress": {
+ "$ref": "#/definitions/Address",
+ "description": "The shipping address."
+ },
+ "currentStatus": {
+ "$ref": "#/definitions/OrderStatus",
+ "description": "Current status of the order.",
+ "readOnly": true
+ },
+ "orderHistory": {
+ "description": "List of status changes in the order.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OrderStatus"
+ },
+ "x-ms-identifiers": [
+ "trackingInformation/serialNumber"
+ ],
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Serial number of the device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deliveryTrackingInfo": {
+ "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrackingInfo"
+ },
+ "x-ms-identifiers": [
+ "serialNumber"
+ ],
+ "readOnly": true
+ },
+ "returnTrackingInfo": {
+ "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrackingInfo"
+ },
+ "x-ms-identifiers": [
+ "serialNumber"
+ ],
+ "readOnly": true
+ },
+ "shipmentType": {
+ "description": "ShipmentType of the order",
+ "enum": [
+ "NotApplicable",
+ "ShippedToCustomer",
+ "SelfPickup"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShipmentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "OrderStatus": {
+ "description": "Represents a single status change.",
+ "required": [
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Status of the order as per the allowed status types.",
+ "enum": [
+ "Untracked",
+ "AwaitingFulfillment",
+ "AwaitingPreparation",
+ "AwaitingShipment",
+ "Shipped",
+ "Arriving",
+ "Delivered",
+ "ReplacementRequested",
+ "LostDevice",
+ "Declined",
+ "ReturnInitiated",
+ "AwaitingReturnShipment",
+ "ShippedBack",
+ "CollectedAtMicrosoft",
+ "AwaitingPickup",
+ "PickupCompleted",
+ "AwaitingDrop"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OrderState",
+ "modelAsString": true
+ }
+ },
+ "updateDateTime": {
+ "format": "date-time",
+ "description": "Time of status update.",
+ "type": "string",
+ "readOnly": true
+ },
+ "comments": {
+ "description": "Comments related to this status change.",
+ "type": "string"
+ },
+ "trackingInformation": {
+ "$ref": "#/definitions/TrackingInfo",
+ "description": "Tracking information related to the state in the ordering flow",
+ "readOnly": true
+ },
+ "additionalOrderDetails": {
+ "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "PeriodicTimerEventTrigger": {
+ "description": "Trigger details.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Trigger"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PeriodicTimerProperties",
+ "description": "Periodic timer trigger properties.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "PeriodicTimerEvent"
+ },
+ "PeriodicTimerProperties": {
+ "description": "Periodic timer trigger properties.",
+ "required": [
+ "sourceInfo",
+ "sinkInfo"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceInfo": {
+ "$ref": "#/definitions/PeriodicTimerSourceInfo",
+ "description": "Periodic timer details."
+ },
+ "sinkInfo": {
+ "$ref": "#/definitions/RoleSinkInfo",
+ "description": "Role Sink information."
+ },
+ "customContextTag": {
+ "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
+ "maxLength": 192,
+ "type": "string"
+ }
+ }
+ },
+ "PeriodicTimerSourceInfo": {
+ "description": "Periodic timer event source.",
+ "required": [
+ "startTime",
+ "schedule"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "Topic where periodic events are published to IoT device.",
+ "type": "string"
+ }
+ }
+ },
+ "ProactiveLogCollectionSettingsProperties": {
+ "description": "The properties of proactive log collection settings.",
+ "required": [
+ "userConsent"
+ ],
+ "type": "object",
+ "properties": {
+ "userConsent": {
+ "description": "Proactive diagnostic collection consent flag",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProactiveDiagnosticsConsent",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RawCertificateData": {
+ "description": "Raw Certificate Data.",
+ "required": [
+ "certificate"
+ ],
+ "type": "object",
+ "properties": {
+ "authenticationType": {
+ "description": "The authentication type.",
+ "enum": [
+ "Invalid",
+ "AzureActiveDirectory"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AuthenticationType",
+ "modelAsString": true
+ }
+ },
+ "certificate": {
+ "description": "The base64 encoded certificate raw data.",
+ "type": "string"
+ }
+ }
+ },
+ "RefreshDetails": {
+ "description": "Fields for tracking refresh job on the share or container.",
+ "type": "object",
+ "properties": {
+ "inProgressRefreshJobId": {
+ "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.",
+ "type": "string"
+ },
+ "lastCompletedRefreshJobTimeInUTC": {
+ "format": "date-time",
+ "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.",
+ "type": "string"
+ },
+ "errorManifestFile": {
+ "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.",
+ "type": "string"
+ },
+ "lastJob": {
+ "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.",
+ "type": "string"
+ }
+ }
+ },
+ "RemoteSupportSettings": {
+ "description": "RemoteApplicationType for which remote support settings is being modified",
+ "type": "object",
+ "properties": {
+ "remoteApplicationType": {
+ "description": "Remote application type",
+ "enum": [
+ "Powershell",
+ "WAC",
+ "LocalUI",
+ "AllApplications"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RemoteApplicationType",
+ "modelAsString": true
+ }
+ },
+ "accessLevel": {
+ "description": "Access level allowed for this remote application type",
+ "enum": [
+ "None",
+ "ReadOnly",
+ "ReadWrite",
+ "FullAccess"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccessLevel",
+ "modelAsString": true
+ }
+ },
+ "expirationTimeStampInUTC": {
+ "format": "date-time",
+ "description": "Expiration time stamp",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceIdentity": {
+ "description": "Msi identity details of the resource",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Identity type",
+ "enum": [
+ "None",
+ "SystemAssigned",
+ "UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MsiIdentityType",
+ "modelAsString": true
+ }
+ },
+ "principalId": {
+ "description": "Service Principal Id backing the Msi",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "description": "Home Tenant Id",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceMoveDetails": {
+ "description": "Fields for tracking resource move",
+ "type": "object",
+ "properties": {
+ "operationInProgress": {
+ "description": "Denotes whether move operation is in progress",
+ "enum": [
+ "None",
+ "ResourceMoveInProgress",
+ "ResourceMoveFailed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceMoveStatus",
+ "modelAsString": true
+ }
+ },
+ "operationInProgressLockTimeoutInUTC": {
+ "format": "date-time",
+ "description": "Denotes the timeout of the operation to finish",
+ "type": "string"
+ }
+ }
+ },
+ "Role": {
+ "description": "Compute role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Role type.",
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Role",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "RoleList": {
+ "description": "Collection of all the roles on the Data Box Edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The Value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Role"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RoleSinkInfo": {
+ "description": "Compute role against which events will be raised.",
+ "required": [
+ "roleId"
+ ],
+ "type": "object",
+ "properties": {
+ "roleId": {
+ "description": "Compute role ID.",
+ "type": "string"
+ }
+ }
+ },
+ "Secret": {
+ "description": "Holds device secret either as a KeyVault reference or as an encrypted value.",
+ "type": "object",
+ "properties": {
+ "encryptedSecret": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Encrypted (using device public key) secret value."
+ },
+ "keyVaultId": {
+ "description": "Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).",
+ "type": "string"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "The security settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SecuritySettingsProperties",
+ "description": "Properties of the security settings.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SecuritySettingsProperties": {
+ "description": "The properties of security settings.",
+ "required": [
+ "deviceAdminPassword"
+ ],
+ "type": "object",
+ "properties": {
+ "deviceAdminPassword": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters."
+ }
+ }
+ },
+ "ServiceSpecification": {
+ "description": "Service specification.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "description": "Metric specification as defined by shoebox.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricSpecification_V1"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "Share": {
+ "description": "Represents a share on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ShareProperties",
+ "description": "The share properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Share",
+ "readOnly": true
+ }
+ }
+ },
+ "ShareAccessRight": {
+ "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.",
+ "required": [
+ "shareId",
+ "accessType"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "The share ID.",
+ "type": "string"
+ },
+ "accessType": {
+ "description": "Type of access to be allowed on the share for this user.",
+ "enum": [
+ "Change",
+ "Read",
+ "Custom"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ShareList": {
+ "description": "Collection of all the shares on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of shares.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Share"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ShareProperties": {
+ "description": "The share properties.",
+ "required": [
+ "shareStatus",
+ "monitoringStatus",
+ "accessProtocol"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description for the share.",
+ "type": "string"
+ },
+ "shareStatus": {
+ "description": "Current status of the share.",
+ "enum": [
+ "Offline",
+ "Unknown",
+ "OK",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareStatus",
+ "modelAsString": true
+ }
+ },
+ "monitoringStatus": {
+ "description": "Current monitoring status of the share.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MonitoringStatus",
+ "modelAsString": true
+ }
+ },
+ "azureContainerInfo": {
+ "$ref": "#/definitions/AzureContainerInfo",
+ "description": "Azure container mapping for the share."
+ },
+ "accessProtocol": {
+ "description": "Access protocol to be used by the share.",
+ "enum": [
+ "SMB",
+ "NFS"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessProtocol",
+ "modelAsString": true
+ }
+ },
+ "userAccessRights": {
+ "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UserAccessRight"
+ },
+ "x-ms-identifiers": [
+ "userId"
+ ]
+ },
+ "clientAccessRights": {
+ "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClientAccessRight"
+ },
+ "x-ms-identifiers": [
+ "client"
+ ]
+ },
+ "refreshDetails": {
+ "$ref": "#/definitions/RefreshDetails",
+ "description": "Details of the refresh job on this share."
+ },
+ "shareMappings": {
+ "description": "Share mount point to the role.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ],
+ "readOnly": true
+ },
+ "dataPolicy": {
+ "description": "Data policy of the share.",
+ "enum": [
+ "Cloud",
+ "Local"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataPolicy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Sku": {
+ "description": "The SKU type.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "SKU name.",
+ "enum": [
+ "Gateway",
+ "Edge",
+ "TEA_1Node",
+ "TEA_1Node_UPS",
+ "TEA_1Node_Heater",
+ "TEA_1Node_UPS_Heater",
+ "TEA_4Node_Heater",
+ "TEA_4Node_UPS_Heater",
+ "TMA",
+ "TDC",
+ "TCA_Small",
+ "GPU",
+ "TCA_Large",
+ "EdgeP_Base",
+ "EdgeP_High",
+ "EdgePR_Base",
+ "EdgePR_Base_UPS",
+ "EP2_64_1VPU_W",
+ "EP2_128_1T4_Mx1_W",
+ "EP2_256_2T4_W",
+ "EdgeMR_Mini",
+ "RCA_Small",
+ "RCA_Large",
+ "RDC",
+ "Management",
+ "EP2_64_Mx1_W",
+ "EP2_128_GPU1_Mx1_W",
+ "EP2_256_GPU2_Mx1",
+ "EdgeMR_TCP"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "description": "The SKU tier. This is based on the SKU name.",
+ "enum": [
+ "Standard"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "SkuCapability": {
+ "description": "The metadata to describe the capability.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "An invariant to describe the feature.",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "An invariant if the feature is measured by quantity.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuCost": {
+ "description": "The metadata for retrieving price info.",
+ "type": "object",
+ "properties": {
+ "meterId": {
+ "description": "Used for querying price from commerce.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quantity": {
+ "format": "int64",
+ "description": "The cost quantity.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "extendedUnit": {
+ "description": "The extended unit.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuLocationInfo": {
+ "description": "The location info.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "zones": {
+ "description": "The zones.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "sites": {
+ "description": "The sites.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "SkuMapping": {
+ "type": "object",
+ "properties": {
+ "catalogPlanId": {
+ "type": "string"
+ },
+ "marketplaceSkuId": {
+ "type": "string"
+ },
+ "marketplaceSkuVersions": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "StorageAccount": {
+ "description": "Represents a Storage Account on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageAccountProperties",
+ "description": "The Storage Account properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of StorageAccount",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredential": {
+ "description": "The storage account credential.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageAccountCredentialProperties",
+ "description": "The storage account credential properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of StorageAccountCredential",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredentialList": {
+ "description": "The collection of storage account credentials.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredentialProperties": {
+ "description": "The storage account credential properties.",
+ "required": [
+ "alias",
+ "sslStatus",
+ "accountType"
+ ],
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias for the storage account.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Username for the storage account.",
+ "type": "string"
+ },
+ "accountKey": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Encrypted storage key."
+ },
+ "connectionString": {
+ "description": "Connection string for the storage account. Use this string if username and account key are not specified.",
+ "type": "string"
+ },
+ "sslStatus": {
+ "description": "Signifies whether SSL needs to be enabled or not.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SSLStatus",
+ "modelAsString": true
+ }
+ },
+ "blobDomainName": {
+ "description": "Blob end point for private clouds.",
+ "type": "string"
+ },
+ "accountType": {
+ "description": "Type of storage accessed on the storage account.",
+ "enum": [
+ "GeneralPurposeStorage",
+ "BlobStorage"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccountType",
+ "modelAsString": true
+ }
+ },
+ "storageAccountId": {
+ "description": "Id of the storage account.",
+ "type": "string"
+ }
+ }
+ },
+ "StorageAccountList": {
+ "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of storageAccounts.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StorageAccount"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountProperties": {
+ "description": "The storage account properties.",
+ "required": [
+ "dataPolicy"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description for the storage Account.",
+ "type": "string"
+ },
+ "storageAccountStatus": {
+ "description": "Current status of the storage account",
+ "enum": [
+ "OK",
+ "Offline",
+ "Unknown",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "StorageAccountStatus",
+ "modelAsString": true
+ }
+ },
+ "dataPolicy": {
+ "description": "Data policy of the storage Account.",
+ "enum": [
+ "Cloud",
+ "Local"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataPolicy",
+ "modelAsString": true
+ }
+ },
+ "storageAccountCredentialId": {
+ "description": "Storage Account Credential Id",
+ "type": "string"
+ },
+ "blobEndpoint": {
+ "description": "BlobEndpoint of Storage Account",
+ "type": "string",
+ "readOnly": true
+ },
+ "containerCount": {
+ "format": "int32",
+ "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "SubscriptionProperties": {
+ "type": "object",
+ "properties": {
+ "tenantId": {
+ "type": "string"
+ },
+ "locationPlacementId": {
+ "type": "string"
+ },
+ "quotaId": {
+ "type": "string"
+ },
+ "serializedDetails": {
+ "type": "string"
+ },
+ "registeredFeatures": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SubscriptionRegisteredFeatures"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "SubscriptionRegisteredFeatures": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ }
+ }
+ },
+ "SupportPackageRequestProperties": {
+ "description": "The share properties.",
+ "type": "object",
+ "properties": {
+ "minimumTimeStamp": {
+ "format": "date-time",
+ "description": "MinimumTimeStamp from where logs need to be collected",
+ "type": "string"
+ },
+ "maximumTimeStamp": {
+ "format": "date-time",
+ "description": "Start of the timespan of the log collection",
+ "type": "string"
+ },
+ "include": {
+ "description": "Type of files, which need to be included in the logs\r\nThis will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)\r\nor a comma separated list of log types that are required",
+ "type": "string"
+ }
+ }
+ },
+ "SymmetricKey": {
+ "description": "Symmetric key for authentication.",
+ "type": "object",
+ "properties": {
+ "connectionString": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Connection string based on the symmetric key."
+ }
+ }
+ },
+ "TrackingInfo": {
+ "description": "Tracking courier information.",
+ "type": "object",
+ "properties": {
+ "serialNumber": {
+ "description": "Serial number of the device being tracked.",
+ "type": "string"
+ },
+ "carrierName": {
+ "description": "Name of the carrier used in the delivery.",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "Tracking ID of the shipment.",
+ "type": "string"
+ },
+ "trackingUrl": {
+ "description": "Tracking URL of the shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "Trigger": {
+ "description": "Trigger details.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Trigger Kind.",
+ "enum": [
+ "FileEvent",
+ "PeriodicTimerEvent"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TriggerEventType",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Trigger",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "TriggerList": {
+ "description": "Collection of all trigger on the data box edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of triggers.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Trigger"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TriggerSupportPackageRequest": {
+ "description": "The request object for trigger support package.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SupportPackageRequestProperties",
+ "description": "The TriggerSupportPackageRequest properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateDetails": {
+ "description": "Update Specific attributes",
+ "type": "object",
+ "properties": {
+ "updateTitle": {
+ "description": "Title of the Update",
+ "type": "string"
+ },
+ "updateSize": {
+ "format": "double",
+ "description": "Size of the update(In Bytes)",
+ "type": "number"
+ },
+ "updateType": {
+ "description": "Type of the Update",
+ "enum": [
+ "Software",
+ "Kubernetes",
+ "Firmware"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UpdateType",
+ "modelAsString": true
+ }
+ },
+ "targetVersion": {
+ "description": "Target Version number",
+ "type": "string"
+ },
+ "friendlyVersionNumber": {
+ "description": "Friendly Version Number",
+ "type": "string"
+ },
+ "estimatedInstallTimeInMins": {
+ "format": "int32",
+ "description": "Estimated Install Time for the update",
+ "type": "integer"
+ },
+ "rebootBehavior": {
+ "description": "Indicates if updates are available and at least one of the updates needs a reboot.",
+ "enum": [
+ "NeverReboots",
+ "RequiresReboot",
+ "RequestReboot"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InstallRebootBehavior",
+ "modelAsString": true
+ }
+ },
+ "installationImpact": {
+ "description": "Impact of Installing an updateType",
+ "enum": [
+ "None",
+ "DeviceRebooted",
+ "KubernetesWorkloadsDown"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InstallationImpact",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "description": "Status of the update.",
+ "enum": [
+ "DownloadPending",
+ "DownloadStarted",
+ "DownloadCompleted",
+ "InstallStarted",
+ "InstallCompleted"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UpdateStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UpdateDownloadProgress": {
+ "description": "Details about the download progress of update.",
+ "type": "object",
+ "properties": {
+ "downloadPhase": {
+ "description": "The download phase.",
+ "enum": [
+ "Unknown",
+ "Initializing",
+ "Downloading",
+ "Verifying"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DownloadPhase",
+ "modelAsString": true
+ }
+ },
+ "percentComplete": {
+ "format": "int32",
+ "description": "Percentage of completion.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalBytesToDownload": {
+ "format": "double",
+ "description": "Total bytes to download.",
+ "type": "number",
+ "readOnly": true
+ },
+ "totalBytesDownloaded": {
+ "format": "double",
+ "description": "Total bytes downloaded.",
+ "type": "number",
+ "readOnly": true
+ },
+ "numberOfUpdatesToDownload": {
+ "format": "int32",
+ "description": "Number of updates to download.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesDownloaded": {
+ "format": "int32",
+ "description": "Number of updates downloaded.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateInstallProgress": {
+ "description": "Progress details during installation of updates.",
+ "type": "object",
+ "properties": {
+ "percentComplete": {
+ "format": "int32",
+ "description": "Percentage completed.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesToInstall": {
+ "format": "int32",
+ "description": "Number of updates to install.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesInstalled": {
+ "format": "int32",
+ "description": "Number of updates installed.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateSummary": {
+ "description": "Details about ongoing updates and availability of updates on the device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UpdateSummaryProperties",
+ "description": "The device update information summary.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of UpdateSummary",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateSummaryProperties": {
+ "description": "The device update information summary.",
+ "type": "object",
+ "properties": {
+ "deviceVersionNumber": {
+ "description": "The current version of the device in format: 1.2.17312.13.\",",
+ "type": "string"
+ },
+ "friendlyDeviceVersionName": {
+ "description": "The current version of the device in text format.",
+ "type": "string"
+ },
+ "deviceLastScannedDateTime": {
+ "format": "date-time",
+ "description": "The last time when a scan was done on the device.",
+ "type": "string"
+ },
+ "lastCompletedScanJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string"
+ },
+ "lastSuccessfulScanJobTime": {
+ "format": "date-time",
+ "description": "Time when the last scan job is successfully completed.",
+ "type": "string"
+ },
+ "lastCompletedDownloadJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCompletedDownloadJobId": {
+ "description": "JobId of the last ran download job.(Can be success/cancelled/failed)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastDownloadJobStatus": {
+ "description": "JobStatus of the last ran download job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "lastSuccessfulInstallJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the Last Install job was completed successfully on the appliance",
+ "type": "string"
+ },
+ "lastCompletedInstallJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCompletedInstallJobId": {
+ "description": "JobId of the last ran install job.(Can be success/cancelled/failed)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastInstallJobStatus": {
+ "description": "JobStatus of the last ran install job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "totalNumberOfUpdatesAvailable": {
+ "format": "int32",
+ "description": "The number of updates available for the current device version as per the last device scan.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalNumberOfUpdatesPendingDownload": {
+ "format": "int32",
+ "description": "The total number of items pending download.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalNumberOfUpdatesPendingInstall": {
+ "format": "int32",
+ "description": "The total number of items pending install.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "rebootBehavior": {
+ "description": "Indicates if updates are available and at least one of the updates needs a reboot.",
+ "enum": [
+ "NeverReboots",
+ "RequiresReboot",
+ "RequestReboot"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "InstallRebootBehavior",
+ "modelAsString": true
+ }
+ },
+ "ongoingUpdateOperation": {
+ "description": "The current update operation.",
+ "enum": [
+ "None",
+ "Scan",
+ "Download",
+ "Install"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "UpdateOperation",
+ "modelAsString": true
+ }
+ },
+ "inProgressDownloadJobId": {
+ "description": "The job ID of the download job in progress.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressInstallJobId": {
+ "description": "The job ID of the install job in progress.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressDownloadJobStartedDateTime": {
+ "format": "date-time",
+ "description": "The time when the currently running download (if any) started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressInstallJobStartedDateTime": {
+ "format": "date-time",
+ "description": "The time when the currently running install (if any) started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "updateTitles": {
+ "description": "The list of updates available for install.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "updates": {
+ "description": "The list of updates available for install.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdateDetails"
+ },
+ "x-ms-identifiers": [
+ "updateTitle"
+ ],
+ "readOnly": true
+ },
+ "totalUpdateSizeInBytes": {
+ "format": "double",
+ "description": "The total size of updates available for download in bytes.",
+ "type": "number",
+ "readOnly": true
+ },
+ "totalTimeInMinutes": {
+ "format": "int32",
+ "description": "The total time in Minutes",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UploadCertificateRequest": {
+ "description": "The upload certificate request.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/RawCertificateData",
+ "description": "The Base 64 encoded certificate raw data.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UploadCertificateResponse": {
+ "description": "The upload registration certificate response.",
+ "type": "object",
+ "properties": {
+ "authType": {
+ "description": "Specifies authentication type.",
+ "enum": [
+ "Invalid",
+ "AzureActiveDirectory"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AuthenticationType",
+ "modelAsString": true
+ }
+ },
+ "resourceId": {
+ "description": "The resource ID of the Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadAuthority": {
+ "description": "Azure Active Directory tenant authority.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadTenantId": {
+ "description": "Azure Active Directory tenant ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "servicePrincipalClientId": {
+ "description": "Azure Active Directory service principal client ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "servicePrincipalObjectId": {
+ "description": "Azure Active Directory service principal object ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "azureManagementEndpointAudience": {
+ "description": "The azure management endpoint audience.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadAudience": {
+ "description": "Identifier of the target resource that is the recipient of the requested token.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "User": {
+ "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UserProperties",
+ "description": "The storage account credential properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of User",
+ "readOnly": true
+ }
+ }
+ },
+ "UserAccessRight": {
+ "description": "The mapping between a particular user and the access type on the SMB share.",
+ "required": [
+ "userId",
+ "accessType"
+ ],
+ "type": "object",
+ "properties": {
+ "userId": {
+ "description": "User ID (already existing in the device).",
+ "type": "string"
+ },
+ "accessType": {
+ "description": "Type of access to be allowed for the user.",
+ "enum": [
+ "Change",
+ "Read",
+ "Custom"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserList": {
+ "description": "Collection of users.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of users.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/User"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UserProperties": {
+ "description": "The user properties.",
+ "required": [
+ "userType"
+ ],
+ "type": "object",
+ "properties": {
+ "encryptedPassword": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "The password details."
+ },
+ "shareAccessRights": {
+ "description": "List of shares that the user has rights on. This field should not be specified during user creation.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ShareAccessRight"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ],
+ "readOnly": true
+ },
+ "userType": {
+ "description": "Type of the user.",
+ "enum": [
+ "Share",
+ "LocalManagement",
+ "ARM"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UserType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "VmMemory": {
+ "description": "VmMemory Data.",
+ "type": "object",
+ "properties": {
+ "startupMemoryMB": {
+ "format": "int64",
+ "description": "The total amount of RAM in the virtual machine, as seen by the guest operating system. For a virtual machine with dynamic memory enabled, this represents the initial memory available at startup.",
+ "type": "integer"
+ },
+ "currentMemoryUsageMB": {
+ "format": "int64",
+ "description": "The current memory used by the virtual machine.",
+ "type": "integer"
+ }
+ }
+ },
+ "VmPlacementRequestResult": {
+ "description": "List of VM sizes being checked for creation on appliance along with corresponding result.",
+ "type": "object",
+ "properties": {
+ "vmSize": {
+ "description": "List of VM sizes being checked.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isFeasible": {
+ "description": "Boolean value indicating if the VM(s) in VmSize can be created.",
+ "type": "boolean"
+ },
+ "messageCode": {
+ "description": "MessageCode indicating reason for success or failure.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Localized message to be displayed to the user to explain the check result.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The API version.",
+ "required": true,
+ "type": "string"
+ },
+ "locationParameter": {
+ "name": "location",
+ "in": "path",
+ "description": "The location of the resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The resource group name.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ },
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow"
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "tags": []
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGet.json
new file mode 100644
index 000000000000..5a33207e8096
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGet.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+ "alertType": "UpdateScanFailedEvent",
+ "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+ "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+ "severity": "Critical",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 1
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "type": "dataBoxEdgeDevices/alerts"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGetAllInDevice.json
new file mode 100644
index 000000000000..704b4f7201fe
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AlertGetAllInDevice.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "title": "Device password has changed",
+ "alertType": "PasswordChangedEvent",
+ "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z",
+ "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.",
+ "severity": "Informational",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 2
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790",
+ "name": "83eccd0b-134b-40b0-ad62-b5f124d03790",
+ "type": "dataBoxEdgeDevices/alerts"
+ },
+ {
+ "properties": {
+ "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+ "alertType": "UpdateScanFailedEvent",
+ "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+ "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+ "severity": "Critical",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 1
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "type": "dataBoxEdgeDevices/alerts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AvailableSkusList.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AvailableSkusList.json
new file mode 100644
index 000000000000..73c9a2b3a94b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/AvailableSkusList.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "location": "westus",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "dataBoxEdgeDevices",
+ "name": "Gateway",
+ "availability": "Available",
+ "tier": "Standard",
+ "kind": "AzureDataBoxGateway",
+ "version": "Stable",
+ "signupOption": "Available",
+ "locations": [
+ "West US"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleDelete.json
new file mode 100644
index 000000000000..77b24bb9b792
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleDelete.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGet.json
new file mode 100644
index 000000000000..635e8d4f22a8
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGetAllInDevice.json
new file mode 100644
index 000000000000..5a8de29d8994
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthScheduleGetAllInDevice.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthSchedulePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthSchedulePut.json
new file mode 100644
index 000000000000..07b0fb2e236e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/BandwidthSchedulePut.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "start": "0:0:0",
+ "stop": "13:59:0",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerDelete.json
new file mode 100644
index 000000000000..21b9a31a5367
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerGet.json
new file mode 100644
index 000000000000..849966ad3867
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerListAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerListAllInDevice.json
new file mode 100644
index 000000000000..938fb4076d99
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerListAllInDevice.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:14:32.3016929Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ },
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:15:38.0077675Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2",
+ "name": "blobcontainer2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ },
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3",
+ "name": "blobcontainer3",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerPut.json
new file mode 100644
index 000000000000..ebcb93af3b61
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerPut.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "container": {
+ "properties": {
+ "dataFormat": "BlockBlob"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer-5e155efe",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerRefresh.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerRefresh.json
new file mode 100644
index 000000000000..4b7a21371240
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ContainerRefresh.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1/refresh/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceDelete.json
new file mode 100644
index 000000000000..a8fc3a7d791c
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByName.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByName.json
new file mode 100644
index 000000000000..85f8a2c13c3b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByName.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "Offline",
+ "serialNumber": "1D6QHQ2",
+ "deviceType": "DataBoxEdgeDevice",
+ "friendlyName": "DBE-1D6QHQ2",
+ "deviceModel": "Physical",
+ "deviceSoftwareVersion": "Azure Stack Edge 2009",
+ "deviceLocalCapacity": 8042259,
+ "timeZone": "Pacific Standard Time",
+ "deviceHcsVersion": "2.1.1361.23408",
+ "configuredRoleTypes": [
+ "CloudEdgeManagement"
+ ],
+ "nodeCount": 1,
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ }
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json
new file mode 100644
index 000000000000..bca215b5c397
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "Offline",
+ "serialNumber": "1D6QHQ2",
+ "deviceType": "DataBoxEdgeDevice",
+ "friendlyName": "DBE-1D6QHQ2",
+ "deviceModel": "Physical",
+ "deviceSoftwareVersion": "Azure Stack Edge 2009",
+ "deviceLocalCapacity": 8042259,
+ "timeZone": "Pacific Standard Time",
+ "deviceHcsVersion": "2.1.1361.23408",
+ "configuredRoleTypes": [
+ "CloudEdgeManagement"
+ ],
+ "nodeCount": 1,
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ },
+ "dataResidency": {
+ "type": "ZoneReplication"
+ },
+ "computeVersionInformation": {
+ "kubernetesVersion": "v1.21.7",
+ "iotEdgeVersion": "0.1.0-beta15",
+ "azureArcVersion": "1.5.3"
+ },
+ "kubernetesPlatform": "AKS"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json
new file mode 100644
index 000000000000..091af0a0256f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "centraluseuap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-18T23%3A31%3A30.3266766Z'\"_W/\"datetime'2020-11-18T23%3A31%3A30.3326804Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "d97a6de5-f5c0-485a-8f5e-b7f705d2dbc4",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/FPGAResource",
+ "name": "FPGAResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "centraluseuap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-18T23%3A31%3A23.1715672Z'\"_W/\"datetime'2020-11-18T23%3A31%3A23.2396152Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "6f2b341b-aded-4ec2-a1bd-d09438d6cc8f",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestVMEdgeResource",
+ "name": "TestVMEdgeResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json
new file mode 100644
index 000000000000..9c7fe72a49f0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A39%3A55.1270082Z'\"_W/\"datetime'2020-11-19T01%3A39%3A55.1320118Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "083df009-06d9-4e3c-ae72-f9249a814334",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/linksub01",
+ "name": "linksub01",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A40%3A05.9246966Z'\"_W/\"datetime'2020-11-19T01%3A40%3A05.9317011Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "8536db30-78d2-4759-95b7-896a66e14c24",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest",
+ "name": "mergeazstest",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A40%3A06.496102Z'\"_W/\"datetime'2020-11-19T01%3A40%3A06.503107Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "fc4c1205-35c8-4f35-abc7-f5a78945f676",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest2",
+ "name": "mergeazstest2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePatch.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePatch.json
new file mode 100644
index 000000000000..987367537f53
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePatch.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "edgeProfile": {
+ "subscription": {
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T04%3A43%3A38.6457308Z'\"_W/\"datetime'2020-11-19T04%3A43%3A38.6507339Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "ReadyToSetup",
+ "deviceType": "DataBoxEdgeDevice",
+ "deviceLocalCapacity": 0,
+ "timeZone": "Pacific Standard Time",
+ "nodeCount": 0,
+ "resourceMoveDetails": {
+ "operationInProgress": "None"
+ },
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice",
+ "name": "testedgedevice",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePut.json
new file mode 100644
index 000000000000..da72447ed0cc
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePut.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "dataBoxEdgeDevice": {
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "name": "testedgedevice"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json
new file mode 100644
index 000000000000..c5c17e13d5dc
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "dataBoxEdgeDevice": {
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "properties": {
+ "dataResidency": {
+ "type": "ZoneReplication"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "name": "testedgedevice",
+ "properties": {
+ "dataResidency": {
+ "type": "ZoneReplication"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteAddons.json
new file mode 100644
index 000000000000..27e412f986fb
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteAddons.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole/addons/arcName/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteMonitoringConfig.json
new file mode 100644
index 000000000000..3643910ed56b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeleteMonitoringConfig.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/testrole/monitoringConfig/default/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityGet.json
new file mode 100644
index 000000000000..28186c1158dd
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityGet.json
@@ -0,0 +1,157 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "timeStamp": "2022-02-28T19:35:34.5585067Z",
+ "clusterStorageCapacityInfo": {
+ "clusterTotalStorageMb": 5368642.0,
+ "clusterFreeStorageMb": 5284151.0
+ },
+ "clusterComputeCapacityInfo": {
+ "fqdn": "3V78B03CL",
+ "gpuCapacity": {
+ "gpuType": "NvidiaTeslaT4",
+ "gpuUsedUnitsCount": 0,
+ "gpuFreeUnitsCount": 1,
+ "gpuReservedForFailoverUnitsCount": 0,
+ "gpuTotalUnitsCount": 1
+ },
+ "memoryCapacity": {
+ "clusterFreeMemoryMb": 20978.64,
+ "clusterUsedMemoryMb": 109711.36,
+ "clusterFailoverMemoryMb": 0.0,
+ "clusterFragmentationMemoryMb": 0.0,
+ "clusterHypervReserveMemoryMb": 19599.36,
+ "clusterInfraVmMemoryMb": 0.0,
+ "clusterTotalMemoryMb": 130690.0,
+ "clusterNonFailoverVmMb": 0.0,
+ "clusterMemoryUsedByVmsMb": 90112.0
+ },
+ "lastRefreshedTime": "2022-02-28T19:35:23.82Z",
+ "totalProvisionedNonHpnCores": 5
+ },
+ "nodeCapacityInfos": {
+ "3V78B03": {
+ "hostName": "3V78B03",
+ "effectiveAvailableMemoryMbOnHost": 45818,
+ "availableGpuCount": 1,
+ "vmUsedMemory": {
+ "2e867196-e44b-49b7-9cb3-46c25973b762": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "23ddd5ea-bda9-467a-803f-1a7e2888d1fa": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 24576
+ },
+ "853efe82-58f1-4f94-8f9c-7752dab6767c": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 24576
+ },
+ "4c4261f0-eac5-4ff6-95ef-2cb70e09d3f6": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "48034ac1-04ce-48e1-89fd-15a6d71fd623": {
+ "startupMemoryMB": 2048,
+ "currentMemoryUsageMB": 2048
+ },
+ "dc3d20b2-8581-41cb-9ca3-1bbc1a8a2fe4": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "c1023a57-d6a0-4a77-9308-48b320bfedbd": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "6b1817d5-4003-4f17-8423-51c33d9de88c": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 0
+ }
+ },
+ "gpuType": "NvidiaTeslaT4",
+ "numaNodesData": [
+ {
+ "numaNodeIndex": 0,
+ "totalMemoryInMb": 65154,
+ "logicalCoreCountPerCore": 2,
+ "effectiveAvailableMemoryInMb": 30182,
+ "freeVCpuIndexesForHpn": [],
+ "vCpuIndexesForHpn": [],
+ "vCpuIndexesForRoot": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8,
+ 9,
+ 10,
+ 11,
+ 12,
+ 13,
+ 14,
+ 15,
+ 16,
+ 17,
+ 18,
+ 19
+ ]
+ },
+ {
+ "numaNodeIndex": 1,
+ "totalMemoryInMb": 65536,
+ "logicalCoreCountPerCore": 2,
+ "effectiveAvailableMemoryInMb": 19493,
+ "freeVCpuIndexesForHpn": [],
+ "vCpuIndexesForHpn": [],
+ "vCpuIndexesForRoot": [
+ 20,
+ 21,
+ 22,
+ 23,
+ 24,
+ 25,
+ 26,
+ 27,
+ 28,
+ 29,
+ 30,
+ 31,
+ 32,
+ 33,
+ 34,
+ 35,
+ 36,
+ 37,
+ 38,
+ 39
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityInfo/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceCapacityInfo"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityRequestPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityRequestPost.json
new file mode 100644
index 000000000000..12f7b0c8bbb3
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DeviceCapacityRequestPost.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "deviceCapacityRequestInfo": {
+ "properties": {
+ "vmPlacementQuery": [
+ [
+ "Standard_D2_v2"
+ ]
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityCheck/Standard_D2_v2/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DownloadUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DownloadUpdatesPost.json
new file mode 100644
index 000000000000..c8bc81bf3d5c
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/DownloadUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/downloadUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ExtendedInfoPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ExtendedInfoPost.json
new file mode 100644
index 000000000000..6460cca67197
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ExtendedInfoPost.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "resourceKey": "3482840729935603111",
+ "encryptionKeyThumbprint": "",
+ "encryptionKey": ""
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice",
+ "name": "testedgedevice",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GenerateCertificate.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GenerateCertificate.json
new file mode 100644
index 000000000000..3dfe73cab1c2
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GenerateCertificate.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "publicKey": "MIIEDjCCAnagAwIBAgIQEW4wrxj9+JdA4kFLDgegTTANBgkqhkiG9w0BAQUFADBDMUEwPwYDVQQDHjgAQwBCAF8AUABvAHIAdABhAGwAXwA2ADMANwA0ADEAMwA1ADkAMQA4ADAAMAA3ADAAOQAxADcANTAeFw0yMDExMTkwNDU2MjBaFw0yMDExMjIwNTA2MjBaMEMxQTA/BgNVBAMeOABDAEIAXwBQAG8AcgB0AGEAbABfADYAMwA3ADQAMQAzADUAOQAxADgAMAAwADcAMAA5ADEANwA1MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqG617KAUc4gOoht527o6FGE/c97W/wZIXqKbx4G8vifljXWw3NGDDuSQfidE3MqSMMJ/AAlDhBH/Deo/PAgUWuWB2WgM+KFWrDS0oDBvLVeIIeiMx4LOsbz4J8IbcKrGWf+ulQyum7dE/yBLzPXcPTjhJP0oMfhGOMlVVWbiKaP78/WZk2PmBQaVv7PxAQnJAPqETH2qAyuc9bd0TaMlIER56WhX9+nzsoI0u7RmBEs8+BaudVroiiK/GpEczy73TCRlpVXGChdBHg+NvYRYz91ltCV9Ijo1bdvcUjdgDJZ4Tz7G8XVCQmxbd9ml6OBLgxQUpd9HSGTcIfFiv+rTUwHR7YkY+1UGHsDPOYnBVDTXs3RFm+c5uNnCKvtyTExDJgabT+FTNb3eyD/BSYsy6b/YZBRqPiO8BRFUsIhWhXtPaUjWOEx6XMeZRnGeF4Hi8iH8TR79kEJhfYy3piSPAc3JrhgoglpyyfZOgyPOje+8tAWS9FHUNyVXKKeksDoZAgMBAAEwDQYJKoZIhvcNAQEFBQADggGBACpfQt34mgr+WlFtY0tqaPAoF6XnVzyKB6XsVAoj1uKFTSCQnr0mWvUMWKSRFTu1bV1VdDokV5I+h92kBcO4ddtHhWtkt16j9XFDsGdDvoUWJeqecZVr9fBPC69wF/9R/2E6iJporR46Pui7gcilYGqb3IjJlh8RT/XBPamQrfDbS7G8eTe91ST5cHr89R6EtDwfyhyTZr2sRrvQrxY2AjEmdH5Zcl9q2Xf8DholZhZ9vwnuYBFfl6VCXWaDAzQWiPdxo1wgXxEpNNDstGFWJKnsnz9UCohNAiPf47B+csPqxjcTLVMhcGLdU/lwpzzkEOciijpYILscvPoU3IM6DmFROgU2z6CForpgwHPDJktyWU1MC7lFdfrSzwu/5b3ZAEQhnJf7rvrybULoYBQWJEuj26Is1S6kXpNUaHAc5HIyIoc2V2eRjasbPIqsU0smjPLS/1egjHxtw9u+v4qDDvDuOjhFJtC3NkPl06TfNgO9+5LgiB1JppXnkLyCQ9RQgw==",
+ "privateKey": null,
+ "expiryTimeInUTC": "2020-11-22T05:06:20.000Z"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetAddons.json
new file mode 100644
index 000000000000..a150eaae5dee
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetAddons.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDCAccessCode.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDCAccessCode.json
new file mode 100644
index 000000000000..fa2c2030580b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDCAccessCode.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "authCode": "_sv7-NY2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json
new file mode 100644
index 000000000000..be4d11d318ac
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "diagnosticProactiveLogCollectionSettings": {
+ "properties": {
+ "userConsent": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userConsent": "Enabled"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticProactiveLogCollectionSettings/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticRemoteSupportSettings.json
new file mode 100644
index 000000000000..86105053ed86
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetDiagnosticRemoteSupportSettings.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00",
+ "remoteApplicationType": "LocalUI"
+ }
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticRemoteSupportSettings/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetMonitoringConfig.json
new file mode 100644
index 000000000000..706d47a52513
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetMonitoringConfig.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetParticularImage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetParticularImage.json
new file mode 100644
index 000000000000..8af098c5f810
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetParticularImage.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "versionName": "20348.707.220505",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220505",
+ "name": "20348.707.220505",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetSASToken.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetSASToken.json
new file mode 100644
index 000000000000..c20f280d1157
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetSASToken.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "versionName": "20348.707.220505",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "sasUri": "https://m-hd-gz1x3bgv4k.z14.net/zbxp2qfw03/abcd?sv=2018-03-2sr=b&si=15d4c566-3d04-4805-a1a-0ecbf110d2&sig%2FsJoKaU%3D"
+ }
+ },
+ "202": {
+ "body": {
+ "status": "InProgress"
+ },
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition/versions/20348.1006.220908/generatesastoken/operationResults/f7bbd5f3-d6e5-4ad5-a0f8-e49877a08f23?api-version=2022-03-01"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetUpdateExtendedInfo.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetUpdateExtendedInfo.json
new file mode 100644
index 000000000000..d32c6e68e728
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/GetUpdateExtendedInfo.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "parameters": {},
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "clientSecretStoreId": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523",
+ "clientSecretStoreUrl": "https://test-keyvault-ccy-523.vault.azure.net",
+ "channelIntegrityKeyName": "ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59",
+ "channelIntegrityKeyVersion": "95e9b619e65f433d82c9e1ead48214b9",
+ "keyVaultSyncStatus": "KeyVaultSynced",
+ "deviceSecrets": {
+ "HcsDataVolumeBitLockerExternalKey": {
+ "keyVaultId": "Id"
+ },
+ "HcsInternalVolumeBitLockerExternalKey": {
+ "keyVaultId": "Id"
+ },
+ "SystemVolumeBitLockerRecoveryKey": {
+ "keyVaultId": "Id"
+ },
+ "SEDEncryptionExternalKeyId": {},
+ "SEDEncryptionExternalKey": {},
+ "BMCDefaultUserPassword": {},
+ "RotateKeyForDataVolumeBitlocker": {},
+ "RotateKeysForSedDrivesSerialized": {}
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/InstallUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/InstallUpdatesPost.json
new file mode 100644
index 000000000000..587107a04ba3
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/InstallUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/installUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/JobsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/JobsGet.json
new file mode 100644
index 000000000000..d89ab76912db
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/JobsGet.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "status": "Succeeded",
+ "startTime": "2018-12-18T02:18:51.4270267Z",
+ "endTime": "2018-12-18T03:18:51.4270267Z",
+ "percentComplete": 100,
+ "properties": {
+ "jobType": "DownloadUpdates",
+ "currentStage": "Success"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListMonitoringConfig.json
new file mode 100644
index 000000000000..06b1125de4d7
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListMonitoringConfig.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffers.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffers.json
new file mode 100644
index 000000000000..1f4da3cca1b0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffers.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver",
+ "name": "windowsserver",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ },
+ {
+ "properties": {
+ "publisherId": "tidalmediainc",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc/offers/ubuntu-20-04",
+ "name": "ubuntu-20-04",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ },
+ {
+ "properties": {
+ "publisherId": "tidalmediainc",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc/offers/ubuntu-18-04",
+ "name": "ubuntu-18-04",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffersbyPublisher.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffersbyPublisher.json
new file mode 100644
index 000000000000..3dacf3c76afa
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListOffersbyPublisher.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver",
+ "name": "windowsserver",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListPublishers.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListPublishers.json
new file mode 100644
index 000000000000..20fdd7896fc1
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListPublishers.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver",
+ "name": "microsoftwindowsserver",
+ "type": "dataBoxEdgeDevices/publishers"
+ },
+ {
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc",
+ "name": "tidalmediainc",
+ "type": "dataBoxEdgeDevices/publishers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListSKUsWithinOffer.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListSKUsWithinOffer.json
new file mode 100644
index 000000000000..23365057e05a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListSKUsWithinOffer.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition",
+ "name": "2022-datacenter-azure-edition",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core",
+ "name": "2022-datacenter-azure-edition-core",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2019-datacenter",
+ "name": "2019-datacenter",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2019-datacenter-gensecond",
+ "name": "2019-datacenter-gensecond",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListVersionswithinSKU.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListVersionswithinSKU.json
new file mode 100644
index 000000000000..04975ba0f780
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ListVersionswithinSKU.json
@@ -0,0 +1,154 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.887.220907",
+ "name": "20348.887.220907",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.887.220806",
+ "name": "20348.887.220806",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.825.220705",
+ "name": "20348.825.220705",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220609",
+ "name": "20348.707.220609",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220505",
+ "name": "20348.707.220505",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.643.220404",
+ "name": "20348.643.220404",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220304",
+ "name": "20348.469.220304",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220203",
+ "name": "20348.469.220203",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220106",
+ "name": "20348.469.220106",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.288.2112080143",
+ "name": "20348.288.2112080143",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.288.2111011613",
+ "name": "20348.288.2111011613",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.112.2110151130",
+ "name": "20348.112.2110151130",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NetworkSettingsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NetworkSettingsGet.json
new file mode 100644
index 000000000000..e47f905b503e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NetworkSettingsGet.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "networkAdapters": [
+ {
+ "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}",
+ "adapterPosition": {
+ "networkGroup": "NonRDMA",
+ "port": 0
+ },
+ "index": 1,
+ "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984",
+ "networkAdapterName": "DATA1",
+ "label": "DATA1",
+ "macAddress": "00155D4E265B",
+ "linkSpeed": 10000000000,
+ "status": "Inactive",
+ "rdmaStatus": "Incapable",
+ "dhcpStatus": "Disabled",
+ "ipv4Configuration": {
+ "ipAddress": "10.150.78.56",
+ "subnet": "255.255.252.0",
+ "gateway": "10.150.76.1"
+ },
+ "ipv6Configuration": {
+ "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf",
+ "prefixLength": 64,
+ "gateway": "fe80::12f3:11ff:fe36:994b%5"
+ },
+ "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5",
+ "dnsServers": [
+ "10.50.50.50",
+ "10.50.10.50"
+ ]
+ }
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NodeGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NodeGetAllInDevice.json
new file mode 100644
index 000000000000..a9b771119a50
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/NodeGetAllInDevice.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "nodeStatus": "Unknown",
+ "nodeChassisSerialNumber": "1D6QHQ2",
+ "nodeSerialNumber": "1D6QHQ2",
+ "nodeDisplayName": "Controller 1",
+ "nodeFriendlySoftwareVersion": "Data Box Edge 1908",
+ "nodeHcsVersion": "1.6.961.8307",
+ "nodeInstanceId": "ad051874-7d27-4ac4-a7b1-b6f231d8a035"
+ },
+ "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2",
+ "name": "1D6QHQ2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"
+ },
+ {
+ "properties": {
+ "nodeStatus": "Unknown",
+ "nodeChassisSerialNumber": "1D6QHQ2",
+ "nodeSerialNumber": "1DCNHQ2",
+ "nodeDisplayName": "Controller 1",
+ "nodeFriendlySoftwareVersion": "Data Box Edge 1908",
+ "nodeHcsVersion": "1.6.961.8307",
+ "nodeInstanceId": "ddf3a76d-ada4-44af-99c6-a69a0e21bcb6"
+ },
+ "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2",
+ "name": "1DCNHQ2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsGet.json
new file mode 100644
index 000000000000..b3fe09b0d5e5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsGet.json
@@ -0,0 +1,675 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "List share users",
+ "description": "Lists or gets the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "List share users",
+ "description": "Lists or gets the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "Creates or updates share users",
+ "description": "Creates or updates the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "Delete share users",
+ "description": "Deletes the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "List bandwidth schedules",
+ "description": "Lists or gets the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "List bandwidth schedules",
+ "description": "Lists or gets the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "Creates or updates bandwidth schedules",
+ "description": "Creates or updates the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "Delete bandwidth schedules",
+ "description": "Deletes the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "List ArmApiRes_roles",
+ "description": "Lists or gets the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "List ArmApiRes_roles",
+ "description": "Lists or gets the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "Creates or updates ArmApiRes_roles",
+ "description": "Creates or updates the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "Delete ArmApiRes_roles",
+ "description": "Deletes the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "List shares",
+ "description": "Lists or gets the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "List shares",
+ "description": "Lists or gets the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "Creates or updates shares",
+ "description": "Creates or updates the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "ArmApiOp_action_refresh_shares",
+ "description": "ArmApiDesc_action_refresh_shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "Delete shares",
+ "description": "Deletes the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Upload certificates",
+ "description": "Upload certificate for device registration"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Creates or updates Data Box Edge devices",
+ "description": "Creates or updates the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Delete Data Box Edge devices",
+ "description": "Deletes the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Creates or updates Data Box Edge devices",
+ "description": "Creates or updates the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices",
+ "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Gets resource extended information",
+ "description": "Retrieves resource extended information"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Device network settings",
+ "operation": "List Device network settings",
+ "description": "Lists or gets the Device network settings"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Device security settings",
+ "operation": "Update security settings",
+ "description": "Update security settings"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "update summary",
+ "operation": "List update summary",
+ "description": "Lists or gets the update summary"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Scan for updates",
+ "description": "Scan for updates"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Download Updates",
+ "description": "Download Updates in device"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Install Updates",
+ "description": "Install Updates on device"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "jobs",
+ "operation": "List jobs",
+ "description": "Lists or gets the jobs"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "Creates or updates storage account credentials",
+ "description": "Creates or updates the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "List storage account credentials",
+ "description": "Lists or gets the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "List storage account credentials",
+ "description": "Lists or gets the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "Delete storage account credentials",
+ "description": "Deletes the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "alerts",
+ "operation": "List alerts",
+ "description": "Lists or gets the alerts"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "alerts",
+ "operation": "List alerts",
+ "description": "Lists or gets the alerts"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Read Data Box Edge device metric definition",
+ "description": "Gets the available Data Box Edge device level metrics"
+ },
+ "origin": "system",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "NICReadThroughput",
+ "displayName": "Read Throughput (Network)",
+ "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "InstanceName",
+ "displayName": "Name",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "NICWriteThroughput",
+ "displayName": "Write Throughput (Network)",
+ "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "InstanceName",
+ "displayName": "Name",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudReadThroughputPerShare",
+ "displayName": "Cloud Download Throughput (Share)",
+ "displayDescription": "The download throughput to Azure from a share during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudUploadThroughputPerShare",
+ "displayName": "Cloud Upload Throughput (Share)",
+ "displayDescription": "The upload throughput to Azure from a share during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "BytesUploadedToCloudPerShare",
+ "displayName": "Cloud Bytes Uploaded (Share)",
+ "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "TotalCapacity",
+ "displayName": "Total Capacity",
+ "displayDescription": "Total Capacity",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Capacity",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "AvailableCapacity",
+ "displayName": "Available Capacity",
+ "displayDescription": "The available capacity in bytes during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Capacity",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudUploadThroughput",
+ "displayName": "Cloud Upload Throughput",
+ "displayDescription": "The cloud upload throughput during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudReadThroughput",
+ "displayName": "Cloud Read Throughput",
+ "displayDescription": "The cloud download throughput during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "BytesUploadedToCloud",
+ "displayName": "Cloud Bytes Uploaded (Device)",
+ "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Write diagnostics setting",
+ "description": "Creates or updates the diagnostics setting for the resource"
+ },
+ "origin": "system"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Read diagnostics setting",
+ "description": "Gets the diagnostic setting for the resource"
+ },
+ "origin": "system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsStatusGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsStatusGet.json
new file mode 100644
index 000000000000..01caf4cd311e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OperationsStatusGet.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "status": "Succeeded",
+ "startTime": "2018-12-18T02:18:51.4270267Z",
+ "endTime": "2018-12-18T03:18:51.4270267Z",
+ "percentComplete": 100,
+ "properties": {
+ "jobType": "DownloadUpdates",
+ "currentStage": "Success"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderDelete.json
new file mode 100644
index 000000000000..b543d2d60a80
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderDelete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGet.json
new file mode 100644
index 000000000000..5a2d5d6879b9
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGet.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGetAllInDevice.json
new file mode 100644
index 000000000000..9ece6846eaa5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderGetAllInDevice.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderPut.json
new file mode 100644
index 000000000000..c55103e2e02b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/OrderPut.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "order": {
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutAddons.json
new file mode 100644
index 000000000000..e7a5d8903281
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutAddons.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "addon": {
+ "kind": "ArcForKubernetes",
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS"
+ }
+ },
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutMonitoringConfig.json
new file mode 100644
index 000000000000..7f4eab306ee0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/PutMonitoringConfig.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "monitoringMetricConfiguration": {
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleDelete.json
new file mode 100644
index 000000000000..c20879fac618
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleDelete.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGet.json
new file mode 100644
index 000000000000..eb8c2533954f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGet.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "kind": "IOT",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGetAllInDevice.json
new file mode 100644
index 000000000000..c9f465a817fd
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleGetAllInDevice.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "kind": "IOT",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleListAddOns.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleListAddOns.json
new file mode 100644
index 000000000000..9b4cec109620
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RoleListAddOns.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "testrg1",
+ "resourceName": "testresource1",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RolePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RolePut.json
new file mode 100644
index 000000000000..ba5a45566e33
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/RolePut.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "role": {
+ "kind": "IOT",
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {
+ "connectionString": {
+ "value": "Encrypted<>",
+ "encryptionCertThumbprint": "348586569999244",
+ "encryptionAlgorithm": "AES256"
+ }
+ }
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {
+ "connectionString": {
+ "value": "Encrypted<>",
+ "encryptionCertThumbprint": "1245475856069999244",
+ "encryptionAlgorithm": "AES256"
+ }
+ }
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "kind": "IOT",
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACDelete.json
new file mode 100644
index 000000000000..21c0738248b6
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGet.json
new file mode 100644
index 000000000000..a2132b59ddc7
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "name": "sac1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGetAllInDevice.json
new file mode 100644
index 000000000000..dd0d8a0af7ce
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACGetAllInDevice.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "alias": "sac1128180128323",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "GeneralPurposeStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323",
+ "name": "sac1128180128323",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ },
+ {
+ "properties": {
+ "alias": "sac1128180128312",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312",
+ "name": "sac1128180128312",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACPut.json
new file mode 100644
index 000000000000..551507be6ce7
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SACPut.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "storageAccountCredential": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "accountKey": {
+ "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==",
+ "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31",
+ "encryptionAlgorithm": "AES256"
+ },
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "name": "sac1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ScanForUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ScanForUpdatesPost.json
new file mode 100644
index 000000000000..ef2ff40f9ea7
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ScanForUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/scanForUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SecuritySettingsUpdatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SecuritySettingsUpdatePost.json
new file mode 100644
index 000000000000..529f38b89060
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SecuritySettingsUpdatePost.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "AzureVM",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "securitySettings": {
+ "properties": {
+ "deviceAdminPassword": {
+ "value": "",
+ "encryptionAlgorithm": "AES256",
+ "encryptionCertThumbprint": ""
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/securitySettings/default/update/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareDelete.json
new file mode 100644
index 000000000000..48e2bb7bdaca
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGet.json
new file mode 100644
index 000000000000..6bfbd8188e69
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGet.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGetAllInDevice.json
new file mode 100644
index 000000000000..94f5537ed99d
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareGetAllInDevice.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SharePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SharePut.json
new file mode 100644
index 000000000000..b444c5d74141
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/SharePut.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "share": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Enabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "dataPolicy": "Cloud"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareRefreshPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareRefreshPost.json
new file mode 100644
index 000000000000..3ee61e713c0d
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/ShareRefreshPost.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare/refresh/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountDelete.json
new file mode 100644
index 000000000000..b14937d43de0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountDelete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGet.json
new file mode 100644
index 000000000000..04ce2ed03b02
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "blobstorageaccount1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGetAllInDevice.json
new file mode 100644
index 000000000000..0f8d062fea0d
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountGetAllInDevice.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountPut.json
new file mode 100644
index 000000000000..58ffb969c1c1
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/StorageAccountPut.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "blobstorageaccount1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "storageAccount": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerDelete.json
new file mode 100644
index 000000000000..34d5990342f6
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGet.json
new file mode 100644
index 000000000000..0830abcfb6d2
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGet.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGetAllInDevice.json
new file mode 100644
index 000000000000..24c99883c74f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerGetAllInDevice.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerPut.json
new file mode 100644
index 000000000000..458e0c0ee300
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerPut.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "trigger": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "kind": "FileEvent"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerSupportPackage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerSupportPackage.json
new file mode 100644
index 000000000000..87ce90225d0a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/TriggerSupportPackage.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "triggerSupportPackageRequest": {
+ "properties": {
+ "minimumTimeStamp": "2018-12-18T02:18:51.4270267Z",
+ "maximumTimeStamp": "2018-12-18T02:19:51.4270267Z",
+ "include": "DefaultWithDumps"
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggerSupportPackage/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json
new file mode 100644
index 000000000000..e166365abf70
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "proactiveLogCollectionSettings": {
+ "properties": {
+ "userConsent": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "userConsent": "Disabled"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-5428209/diagnosticProactiveLogCollectionSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json
new file mode 100644
index 000000000000..41d89be7d33e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "diagnosticRemoteSupportSettings": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00",
+ "remoteApplicationType": "Powershell"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "remoteApplicationType": "Powershell",
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2500-09-14T00:00:00+00:00"
+ }
+ ]
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-154c8a4/diagnosticRemoteSupportSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateSummaryGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateSummaryGet.json
new file mode 100644
index 000000000000..fce5b8009546
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UpdateSummaryGet.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "deviceVersionNumber": "2.1.1377.2170",
+ "friendlyDeviceVersionName": "Azure Stack Edge 2010",
+ "deviceLastScannedDateTime": "2021-03-17T19:51:51.7864634Z",
+ "lastCompletedScanJobDateTime": "2021-03-17T19:47:46.1595547Z",
+ "lastDownloadJobStatus": "Invalid",
+ "lastInstallJobStatus": "Invalid",
+ "totalNumberOfUpdatesAvailable": 1,
+ "totalNumberOfUpdatesPendingDownload": 1,
+ "totalNumberOfUpdatesPendingInstall": 1,
+ "rebootBehavior": "NeverReboots",
+ "ongoingUpdateOperation": "Install",
+ "updateTitles": [
+ "Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R"
+ ],
+ "totalUpdateSizeInBytes": 4260898192.0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UploadCertificatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UploadCertificatePost.json
new file mode 100644
index 000000000000..2a67ad1850cd
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UploadCertificatePost.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "authType": "AzureActiveDirectory",
+ "resourceId": "392799901267771",
+ "aadAuthority": "https://login.windows.net",
+ "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909",
+ "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68",
+ "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4",
+ "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserDelete.json
new file mode 100644
index 000000000000..0a7b910142a9
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserDelete.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGet.json
new file mode 100644
index 000000000000..474b9a391d00
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ },
+ "202": {}
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGetAllInDevice.json
new file mode 100644
index 000000000000..70cdf7a8b00b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserGetAllInDevice.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "name": "user2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ },
+ {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserPut.json
new file mode 100644
index 000000000000..dbc1c387e7d3
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2022-12-01-preview/examples/UserPut.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "user": {
+ "properties": {
+ "encryptedPassword": {
+ "value": "",
+ "encryptionAlgorithm": "None",
+ "encryptionCertThumbprint": "blah"
+ },
+ "userType": "Share"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json
new file mode 100644
index 000000000000..7cdc324a5302
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json
@@ -0,0 +1,10476 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2023-01-01-preview",
+ "title": "DataBoxEdgeManagementClient"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.DataBoxEdge/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "summary": "List all the supported operations.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of supported operations.",
+ "schema": {
+ "$ref": "#/definitions/OperationsList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OperationsGet": {
+ "$ref": "./examples/OperationsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": {
+ "get": {
+ "tags": [
+ "AvailableSkus"
+ ],
+ "summary": "List all the available Skus and information related to them.",
+ "operationId": "AvailableSkus_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists the available Skus and information related to them.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeSkuList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AvailableSkus": {
+ "$ref": "./examples/AvailableSkusList.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.",
+ "operationId": "Devices_ListBySubscription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of Data Box Edge/Data Box Gateway devices.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetBySubscription": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.",
+ "operationId": "Devices_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of Data Box Edge/Data Box Gateway devices.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetByResourceGroup": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The Data Box Edge/Data Box Gateway device.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceGetByName": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByName.json"
+ },
+ "DataBoxEdgeDeviceGetByNameWithDataResidency": {
+ "$ref": "./examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.",
+ "operationId": "Devices_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "dataBoxEdgeDevice",
+ "in": "body",
+ "description": "The resource object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the resource.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDevicePut": {
+ "$ref": "./examples/DataBoxEdgeDevicePut.json"
+ },
+ "DataBoxEdgeDevicePutWithDataResidency": {
+ "$ref": "./examples/DataBoxEdgeDevicePutWithDataResidency.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Deletes the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the resource."
+ },
+ "204": {
+ "description": "The resource is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDeviceDelete": {
+ "$ref": "./examples/DataBoxEdgeDeviceDelete.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Modifies a Data Box Edge/Data Box Gateway resource.",
+ "operationId": "Devices_Update",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The resource parameters.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevicePatch"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the resource.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DataBoxEdgeDevicePatch": {
+ "$ref": "./examples/DataBoxEdgeDevicePatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": {
+ "get": {
+ "tags": [
+ "Alerts"
+ ],
+ "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Alerts_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of alerts.",
+ "schema": {
+ "$ref": "#/definitions/AlertList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "AlertGetAllInDevice": {
+ "$ref": "./examples/AlertGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": {
+ "get": {
+ "tags": [
+ "Alerts"
+ ],
+ "summary": "Gets an alert by name.",
+ "operationId": "Alerts_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The alert name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The alert details.",
+ "schema": {
+ "$ref": "#/definitions/Alert"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "AlertGet": {
+ "$ref": "./examples/AlertGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": {
+ "get": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.",
+ "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of bandwidth schedules.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedulesList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "BandwidthScheduleGetAllInDevice": {
+ "$ref": "./examples/BandwidthScheduleGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": {
+ "get": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Gets the properties of the specified bandwidth schedule.",
+ "operationId": "BandwidthSchedules_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The bandwidth schedule.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "BandwidthScheduleGet": {
+ "$ref": "./examples/BandwidthScheduleGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Creates or updates a bandwidth schedule.",
+ "operationId": "BandwidthSchedules_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name which needs to be added/updated.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The bandwidth schedule to be added or updated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the bandwidth schedule.",
+ "schema": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the bandwidth schedule."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "BandwidthSchedulePut": {
+ "$ref": "./examples/BandwidthSchedulePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BandwidthSchedules"
+ ],
+ "description": "Deletes the specified bandwidth schedule.",
+ "operationId": "BandwidthSchedules_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The bandwidth schedule name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success"
+ },
+ "202": {
+ "description": "Accepted the request to delete the bandwidth schedule."
+ },
+ "204": {
+ "description": "Successfully deleted the bandwidth schedule."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "BandwidthScheduleDelete": {
+ "$ref": "./examples/BandwidthScheduleDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck": {
+ "post": {
+ "tags": [
+ "DeviceCapacityCheck"
+ ],
+ "description": "Posts the device capacity request info to check feasibility.",
+ "operationId": "DeviceCapacityCheck_CheckResourceCreationFeasibility",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deviceCapacityRequestInfo",
+ "in": "body",
+ "description": "The device capacity request info.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeviceCapacityRequestInfo"
+ }
+ },
+ {
+ "name": "capacityName",
+ "in": "query",
+ "description": "The capacity name.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to check the feasibility of resource creation."
+ },
+ "200": {
+ "description": "Successfully checked the feasibility of resource creation."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "DeviceCapacityRequestPost": {
+ "$ref": "./examples/DeviceCapacityRequestPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default": {
+ "get": {
+ "tags": [
+ "DeviceCapacityInfo"
+ ],
+ "description": "Gets the properties of the specified device capacity info.",
+ "operationId": "DeviceCapacityInfo_GetDeviceCapacityInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The device capacity info result.",
+ "schema": {
+ "$ref": "#/definitions/DeviceCapacityInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "DeviceCapacityGet": {
+ "$ref": "./examples/DeviceCapacityGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticProactiveLogCollectionSettings/default": {
+ "get": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_GetDiagnosticProactiveLogCollectionSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The diagnostic proactive log collection settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDiagnosticProactiveLogCollectionSettings": {
+ "$ref": "./examples/GetDiagnosticProactiveLogCollectionSettings.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_UpdateDiagnosticProactiveLogCollectionSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "proactiveLogCollectionSettings",
+ "in": "body",
+ "description": "The proactive log collection settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the proactive log collection settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticProactiveLogCollectionSettings"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to update the proactive log collection settings."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UpdateDiagnosticProactiveLogCollectionSettings": {
+ "$ref": "./examples/UpdateDiagnosticProactiveLogCollectionSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/diagnosticRemoteSupportSettings/default": {
+ "get": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_GetDiagnosticRemoteSupportSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The diagnostic remote support settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDiagnosticRemoteSupportSettings": {
+ "$ref": "./examples/GetDiagnosticRemoteSupportSettings.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DiagnosticSettings"
+ ],
+ "description": "Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "DiagnosticSettings_UpdateDiagnosticRemoteSupportSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticRemoteSupportSettings",
+ "in": "body",
+ "description": "The diagnostic remote support settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to update the diagnostic remote support settings."
+ },
+ "200": {
+ "description": "Successfully updated the diagnostic remote support settings.",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UpdateDiagnosticRemoteSupportSettings": {
+ "$ref": "./examples/UpdateDiagnosticRemoteSupportSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_DownloadUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully downloaded the updates on the device."
+ },
+ "202": {
+ "description": "Accepted the request to download the updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DownloadUpdatesPost": {
+ "$ref": "./examples/DownloadUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Generates certificate for activation key.",
+ "operationId": "Devices_GenerateCertificate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully generated self signed certificate.",
+ "schema": {
+ "$ref": "#/definitions/GenerateCertResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GenerateCertificate": {
+ "$ref": "./examples/GenerateCertificate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.",
+ "operationId": "Devices_GetExtendedInformation",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The additional information.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ExtendedInfoPost": {
+ "$ref": "./examples/ExtendedInfoPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_InstallUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully installed updates on the device."
+ },
+ "202": {
+ "description": "Accepted the request to install updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "InstallUpdatesPost": {
+ "$ref": "./examples/InstallUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": {
+ "get": {
+ "tags": [
+ "Jobs"
+ ],
+ "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Jobs_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The job name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The job details.",
+ "schema": {
+ "$ref": "#/definitions/Job"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "JobsGet": {
+ "$ref": "./examples/JobsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_GetNetworkSettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The device network settings.",
+ "schema": {
+ "$ref": "#/definitions/NetworkSettings"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "NetworkSettingsGet": {
+ "$ref": "./examples/NetworkSettingsGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": {
+ "get": {
+ "tags": [
+ "Nodes"
+ ],
+ "description": "Gets all the nodes currently configured under this Data Box Edge device",
+ "operationId": "Nodes_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all nodes on the device.",
+ "schema": {
+ "$ref": "#/definitions/NodeList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "NodesGetAllInDevice": {
+ "$ref": "./examples/NodeGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/offers": {
+ "get": {
+ "tags": [
+ "MarketplaceImageOffer"
+ ],
+ "summary": "Returns list of all offers",
+ "operationId": "MarketplaceImageOffer_ListOffers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListOffers is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageOfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListOffers.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": {
+ "get": {
+ "tags": [
+ "OperationsStatus"
+ ],
+ "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "OperationsStatus_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The job name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The job details.",
+ "schema": {
+ "$ref": "#/definitions/Job"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OperationsStatusGet": {
+ "$ref": "./examples/OperationsStatusGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": {
+ "get": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Orders_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Lists all the orders for the Data Box Edge Device",
+ "schema": {
+ "$ref": "#/definitions/OrderList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGetAllInDevice": {
+ "$ref": "./examples/OrderGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": {
+ "get": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Gets a specific order by name.",
+ "operationId": "Orders_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The order details of a device.",
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/OrderGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Creates or updates an order.",
+ "operationId": "Orders_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The order details of a device.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "order",
+ "in": "body",
+ "description": "The order to be created or updated.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the order.",
+ "schema": {
+ "$ref": "#/definitions/Order"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the order."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "OrderPut": {
+ "$ref": "./examples/OrderPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Deletes the order related to the device.",
+ "operationId": "Orders_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the order."
+ },
+ "202": {
+ "description": "Accepted the request to delete the order."
+ },
+ "204": {
+ "description": "The order is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "OrderDelete": {
+ "$ref": "./examples/OrderDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode": {
+ "post": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Gets the DCAccess Code",
+ "operationId": "Orders_ListDCAccessCode",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "DC Access code for the device",
+ "schema": {
+ "$ref": "#/definitions/DCAccessCode"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetDCAccessCode": {
+ "$ref": "./examples/GetDCAccessCode.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers": {
+ "get": {
+ "tags": [
+ "MarketplaceImagePublisher"
+ ],
+ "summary": "Returns list of publishers",
+ "operationId": "MarketplaceImagePublisher_ListPublishers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListPublishers is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImagePublisherList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListPublishers.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers": {
+ "get": {
+ "tags": [
+ "MarketplaceImageOffer"
+ ],
+ "summary": "Returns List of Offers by Publisher name",
+ "operationId": "MarketplaceImageOffer_ListOffersbyPublisher",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListOffersbyPublisher is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageOfferList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListOffersbyPublisher.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus": {
+ "get": {
+ "tags": [
+ "MarketplaceImageSku"
+ ],
+ "summary": "Returns List of SKUs Within Offer",
+ "operationId": "MarketplaceImageSku_ListSKUsWithinOffer",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListSKUsWithinOffer is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageSkuList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListSKUsWithinOffer.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions": {
+ "get": {
+ "tags": [
+ "MarketplaceImageVersion"
+ ],
+ "summary": "Returns List of Versions within SKU",
+ "operationId": "MarketplaceImageVersion_ListVersionswithinSKU",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "ListVersionswithinSKU is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageVersionList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/ListVersionswithinSKU.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}": {
+ "get": {
+ "tags": [
+ "MarketplaceImageVersion"
+ ],
+ "description": "Get Particular Image",
+ "operationId": "MarketplaceImageVersion_GetParticularImage",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "versionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "GetParticularImage is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceImageVersion"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/GetParticularImage.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}/versions/{versionName}/generatesastoken": {
+ "post": {
+ "tags": [
+ "MarketplaceImageSasToken"
+ ],
+ "summary": "Returns SASToken",
+ "operationId": "MarketplaceImageSasToken_GetSASToken",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "publisherName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "offerName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "skuName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "name": "versionName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string",
+ "pattern": "[ A-Za-z0-9_@./#&+-]*"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to start VM Image Download",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceSasToken"
+ },
+ "headers": {
+ "Location": {
+ "type": "string"
+ }
+ }
+ },
+ "200": {
+ "description": "GetSASToken is working fine",
+ "schema": {
+ "$ref": "#/definitions/MarketplaceSasToken"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "OrderGet": {
+ "$ref": "./examples/GetSASToken.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": {
+ "get": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Roles_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of all the roles configured in the device.",
+ "schema": {
+ "$ref": "#/definitions/RoleList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "RoleGetAllInDevice": {
+ "$ref": "./examples/RoleGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": {
+ "get": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Gets a specific role by name.",
+ "operationId": "Roles_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The role with the specified name in the given device.",
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "RoleGet": {
+ "$ref": "./examples/RoleGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Create or update a role.",
+ "operationId": "Roles_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "role",
+ "in": "body",
+ "description": "The role properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the role.",
+ "schema": {
+ "$ref": "#/definitions/Role"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the role."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RolePut": {
+ "$ref": "./examples/RolePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Roles"
+ ],
+ "description": "Deletes the role on the device.",
+ "operationId": "Roles_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the role."
+ },
+ "202": {
+ "description": "Accepted the request to delete the role."
+ },
+ "204": {
+ "description": "The role is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "RoleDelete": {
+ "$ref": "./examples/RoleDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons": {
+ "get": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Lists all the addons configured in the role.",
+ "operationId": "Addons_ListByRole",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of all the addons configured in the role.",
+ "schema": {
+ "$ref": "#/definitions/AddonList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "RoleListAddOns": {
+ "$ref": "./examples/RoleListAddOns.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}": {
+ "get": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Gets a specific addon by name.",
+ "operationId": "Addons_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The addon with the specified name in the role.",
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAddOns": {
+ "$ref": "./examples/GetAddons.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Create or update a addon.",
+ "operationId": "Addons_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addon",
+ "in": "body",
+ "description": "The addon properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the addon.",
+ "schema": {
+ "$ref": "#/definitions/Addon"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the addon."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "PutAddOns": {
+ "$ref": "./examples/PutAddons.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Addons"
+ ],
+ "description": "Deletes the addon on the device.",
+ "operationId": "Addons_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "addonName",
+ "in": "path",
+ "description": "The addon name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the addon."
+ },
+ "202": {
+ "description": "Accepted the request to delete the addon."
+ },
+ "204": {
+ "description": "The addon is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DeleteAddOns": {
+ "$ref": "./examples/DeleteAddons.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig": {
+ "get": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Lists metric configurations in a role.",
+ "operationId": "MonitoringConfig_List",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The monitoring config details.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfigurationList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ListMonitoringConfig": {
+ "$ref": "./examples/ListMonitoringConfig.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default": {
+ "get": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Gets a metric configuration of a role.",
+ "operationId": "MonitoringConfig_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The monitoring config details.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetMonitoringConfig": {
+ "$ref": "./examples/GetMonitoringConfig.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "Creates a new metric configuration or updates an existing one for a role.",
+ "operationId": "MonitoringConfig_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "monitoringMetricConfiguration",
+ "in": "body",
+ "description": "The metric configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the metrics configuration.",
+ "schema": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the metrics configuration."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "PutMonitoringConfig": {
+ "$ref": "./examples/PutMonitoringConfig.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "MonitoringConfig"
+ ],
+ "summary": "deletes a new metric configuration for a role.",
+ "operationId": "MonitoringConfig_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "roleName",
+ "in": "path",
+ "description": "The role name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the metrics configuration."
+ },
+ "202": {
+ "description": "Accepted the request to delete the metrics configuration."
+ },
+ "204": {
+ "description": "The metrics configuration is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "DeleteMonitoringConfig": {
+ "$ref": "./examples/DeleteMonitoringConfig.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_ScanForUpdates",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully scanned the device for updates."
+ },
+ "202": {
+ "description": "Accepted the request to scan for updates on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ScanForUpdatesPost": {
+ "$ref": "./examples/ScanForUpdatesPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_CreateOrUpdateSecuritySettings",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "securitySettings",
+ "in": "body",
+ "description": "The security settings.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SecuritySettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to update the security settings."
+ },
+ "204": {
+ "description": "Updated the security settings."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "CreateOrUpdateSecuritySettings": {
+ "$ref": "./examples/SecuritySettingsUpdatePost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": {
+ "get": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Shares_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the shares on the device.",
+ "schema": {
+ "$ref": "#/definitions/ShareList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ShareGetAllInDevice": {
+ "$ref": "./examples/ShareGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": {
+ "get": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Gets a share by name.",
+ "operationId": "Shares_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The share details.",
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ShareGet": {
+ "$ref": "./examples/ShareGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Creates a new share or updates an existing share on the device.",
+ "operationId": "Shares_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "share",
+ "in": "body",
+ "description": "The share properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the share.",
+ "schema": {
+ "$ref": "#/definitions/Share"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the share."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SharePut": {
+ "$ref": "./examples/SharePut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Shares"
+ ],
+ "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Shares_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the share."
+ },
+ "202": {
+ "description": "Accepted the request to delete the share."
+ },
+ "204": {
+ "description": "The share is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ShareDelete": {
+ "$ref": "./examples/ShareDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": {
+ "post": {
+ "tags": [
+ "Shares"
+ ],
+ "summary": "Refreshes the share metadata with the data from the cloud.",
+ "operationId": "Shares_Refresh",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The share name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed the share on the device."
+ },
+ "202": {
+ "description": "Accepted the request to refresh the share on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ShareRefreshPost": {
+ "$ref": "./examples/ShareRefreshPost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": {
+ "get": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of storage account credentials.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredentialList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "SACGetAllInDevice": {
+ "$ref": "./examples/SACGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": {
+ "get": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Gets the properties of the specified storage account credential.",
+ "operationId": "StorageAccountCredentials_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The storage account credential properties.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "SACGet": {
+ "$ref": "./examples/SACGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Creates or updates the storage account credential.",
+ "operationId": "StorageAccountCredentials_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountCredential",
+ "in": "body",
+ "description": "The storage account credential.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the storage account credential.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the storage account credential."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SACPut": {
+ "$ref": "./examples/SACPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StorageAccountCredentials"
+ ],
+ "description": "Deletes the storage account credential.",
+ "operationId": "StorageAccountCredentials_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The storage account credential name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the storage account credential."
+ },
+ "202": {
+ "description": "Accepted the request to delete the storage account credential."
+ },
+ "204": {
+ "description": "The storage account credential is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SACDelete": {
+ "$ref": "./examples/SACDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": {
+ "get": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccounts_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the StorageAccounts on the device.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "StorageAccountGetAllInDevice": {
+ "$ref": "./examples/StorageAccountGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": {
+ "get": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Gets a StorageAccount by name.",
+ "operationId": "StorageAccounts_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The storage account name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The storage account details.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "StorageAccountGet": {
+ "$ref": "./examples/StorageAccountGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.",
+ "operationId": "StorageAccounts_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The StorageAccount name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccount",
+ "in": "body",
+ "description": "The StorageAccount properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the StorageAccount.",
+ "schema": {
+ "$ref": "#/definitions/StorageAccount"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the StorageAccount."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StorageAccountPut": {
+ "$ref": "./examples/StorageAccountPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StorageAccounts"
+ ],
+ "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "StorageAccounts_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The StorageAccount name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to delete the StorageAccount."
+ },
+ "204": {
+ "description": "The StorageAccount is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StorageAccountDelete": {
+ "$ref": "./examples/StorageAccountDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": {
+ "get": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Containers_ListByStorageAccount",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The storage Account name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all the containers on the device.",
+ "schema": {
+ "$ref": "#/definitions/ContainerList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "ContainerListAllInDevice": {
+ "$ref": "./examples/ContainerListAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": {
+ "get": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Gets a container by name.",
+ "operationId": "Containers_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The container details.",
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "ContainerGet": {
+ "$ref": "./examples/ContainerGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Creates a new container or updates an existing container on the device.",
+ "operationId": "Containers_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "container",
+ "in": "body",
+ "description": "The container properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the container.",
+ "schema": {
+ "$ref": "#/definitions/Container"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the container."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerPut": {
+ "$ref": "./examples/ContainerPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Containers"
+ ],
+ "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.",
+ "operationId": "Containers_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted the request to delete the container."
+ },
+ "204": {
+ "description": "The container is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerDelete": {
+ "$ref": "./examples/ContainerDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": {
+ "post": {
+ "tags": [
+ "Containers"
+ ],
+ "summary": "Refreshes the container metadata with the data from the cloud.",
+ "operationId": "Containers_Refresh",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "storageAccountName",
+ "in": "path",
+ "description": "The Storage Account Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "containerName",
+ "in": "path",
+ "description": "The container name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully refreshed the container on the device."
+ },
+ "202": {
+ "description": "Accepted the request to refresh the container on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ContainerRefresh": {
+ "$ref": "./examples/ContainerRefresh.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": {
+ "get": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Lists all the triggers configured in the device.",
+ "operationId": "Triggers_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List all the triggers configured in the device",
+ "schema": {
+ "$ref": "#/definitions/TriggerList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "TriggerGetAllInDevice": {
+ "$ref": "./examples/TriggerGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": {
+ "get": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Get a specific trigger by name.",
+ "operationId": "Triggers_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The trigger.",
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "TriggerGet": {
+ "$ref": "./examples/TriggerGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Creates or updates a trigger.",
+ "operationId": "Triggers_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "Creates or updates a trigger",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "trigger",
+ "in": "body",
+ "description": "The trigger.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the trigger.",
+ "schema": {
+ "$ref": "#/definitions/Trigger"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the trigger."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerPut": {
+ "$ref": "./examples/TriggerPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Triggers"
+ ],
+ "description": "Deletes the trigger on the gateway device.",
+ "operationId": "Triggers_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The trigger name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the trigger."
+ },
+ "202": {
+ "description": "Accepted the request to delete the trigger."
+ },
+ "204": {
+ "description": "The trigger is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerDelete": {
+ "$ref": "./examples/TriggerDelete.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage": {
+ "post": {
+ "tags": [
+ "SupportPackages"
+ ],
+ "summary": "Triggers support package on the device",
+ "operationId": "SupportPackages_TriggerSupportPackage",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "triggerSupportPackageRequest",
+ "in": "body",
+ "description": "The trigger support package request object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerSupportPackageRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully triggered support package on the device."
+ },
+ "202": {
+ "description": "Accepted the request to trigger support package on the device."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "TriggerSupportPackage": {
+ "$ref": "./examples/TriggerSupportPackage.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.",
+ "operationId": "Devices_UpdateExtendedInformation",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The patch object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoPatch"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Modify additional information.",
+ "schema": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetUpdateExtendedInfo": {
+ "$ref": "./examples/GetUpdateExtendedInfo.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": {
+ "get": {
+ "tags": [
+ "Devices"
+ ],
+ "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.",
+ "operationId": "Devices_GetUpdateSummary",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The update summary.",
+ "schema": {
+ "$ref": "#/definitions/UpdateSummary"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UpdateSummaryGet": {
+ "$ref": "./examples/UpdateSummaryGet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": {
+ "post": {
+ "tags": [
+ "Devices"
+ ],
+ "description": "Uploads registration certificate for the device.",
+ "operationId": "Devices_UploadCertificate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "The upload certificate request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UploadCertificateRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully uploaded the registration certificate.",
+ "schema": {
+ "$ref": "#/definitions/UploadCertificateResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UploadCertificatePost": {
+ "$ref": "./examples/UploadCertificatePost.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Users_ListByDataBoxEdgeDevice",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Specify $filter='Type eq ' to filter on user type property",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The collection of all users on the device.",
+ "schema": {
+ "$ref": "#/definitions/UserList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "UserGetAllInDevice": {
+ "$ref": "./examples/UserGetAllInDevice.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Gets the properties of the specified user.",
+ "operationId": "Users_Get",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The user details.",
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UserGet": {
+ "$ref": "./examples/UserGet.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.",
+ "operationId": "Users_CreateOrUpdate",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "user",
+ "in": "body",
+ "description": "The user details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated the user.",
+ "schema": {
+ "$ref": "#/definitions/User"
+ }
+ },
+ "202": {
+ "description": "Accepted the request to create or update the user."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UserPut": {
+ "$ref": "./examples/UserPut.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Users"
+ ],
+ "description": "Deletes the user on a databox edge/gateway device.",
+ "operationId": "Users_Delete",
+ "parameters": [
+ {
+ "name": "deviceName",
+ "in": "path",
+ "description": "The device name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The user name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted the user."
+ },
+ "202": {
+ "description": "Accepted the request to delete the user."
+ },
+ "204": {
+ "description": "The user is already deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "UserDelete": {
+ "$ref": "./examples/UserDelete.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Addon": {
+ "description": "Role Addon",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Addon type.",
+ "enum": [
+ "IotEdge",
+ "ArcForKubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AddonType",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Addon",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "AddonList": {
+ "description": "Collection of all the Role addon on the Azure Stack Edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The Value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Addon"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Address": {
+ "description": "The shipping address of the customer.",
+ "required": [
+ "country"
+ ],
+ "type": "object",
+ "properties": {
+ "addressLine1": {
+ "description": "The address line1.",
+ "type": "string"
+ },
+ "addressLine2": {
+ "description": "The address line2.",
+ "type": "string"
+ },
+ "addressLine3": {
+ "description": "The address line3.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code.",
+ "type": "string"
+ },
+ "city": {
+ "description": "The city name.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state name.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country name.",
+ "type": "string"
+ }
+ }
+ },
+ "Alert": {
+ "description": "Alert on the data box edge/gateway device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AlertProperties",
+ "description": "Properties of alert.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Alert",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertErrorDetails": {
+ "description": "Error details for the alert.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "description": "Error code.",
+ "type": "string",
+ "readOnly": true
+ },
+ "errorMessage": {
+ "description": "Error Message.",
+ "type": "string",
+ "readOnly": true
+ },
+ "occurrences": {
+ "format": "int32",
+ "description": "Number of occurrences.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertList": {
+ "description": "Collection of alerts.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Alert"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AlertProperties": {
+ "description": "Properties of alert.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Alert title.",
+ "type": "string",
+ "readOnly": true
+ },
+ "alertType": {
+ "description": "Alert type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "appearedAtDateTime": {
+ "format": "date-time",
+ "description": "UTC time when the alert appeared.",
+ "type": "string",
+ "readOnly": true
+ },
+ "recommendation": {
+ "description": "Alert recommendation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "severity": {
+ "description": "Severity of the alert.",
+ "enum": [
+ "Informational",
+ "Warning",
+ "Critical"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AlertSeverity",
+ "modelAsString": true
+ }
+ },
+ "errorDetails": {
+ "$ref": "#/definitions/AlertErrorDetails",
+ "description": "Error details of the alert.",
+ "readOnly": true
+ },
+ "detailedInformation": {
+ "description": "Alert details.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ArcAddon": {
+ "description": "Arc Addon.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Addon"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ArcAddonProperties",
+ "description": "Properties specific to Arc addon.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "ArcForKubernetes"
+ },
+ "ArcAddonProperties": {
+ "description": "Arc addon properties.",
+ "required": [
+ "subscriptionId",
+ "resourceGroupName",
+ "resourceName",
+ "resourceLocation"
+ ],
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "description": "Arc resource subscription Id",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "Arc resource group name",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Arc resource Name",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Arc resource location",
+ "type": "string"
+ },
+ "version": {
+ "description": "Arc resource version",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostPlatform": {
+ "description": "Host OS supported by the Arc addon.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "hostPlatformType": {
+ "description": "Platform where the runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "customLocationsObjectId": {
+ "type": "string",
+ "description": "Arc Custom Locations ObjectId",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Addon Provisioning State",
+ "enum": [
+ "Invalid",
+ "Creating",
+ "Created",
+ "Updating",
+ "Reconfiguring",
+ "Failed",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AddonState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ARMBaseModel": {
+ "description": "Represents the base class for all object models.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "AsymmetricEncryptedSecret": {
+ "description": "Represent the secrets intended for encryption with asymmetric key pair.",
+ "required": [
+ "value",
+ "encryptionAlgorithm"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value of the secret.",
+ "type": "string"
+ },
+ "encryptionCertThumbprint": {
+ "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.",
+ "x-ms-secret": true,
+ "type": "string"
+ },
+ "encryptionAlgorithm": {
+ "description": "The algorithm used to encrypt \"Value\".",
+ "enum": [
+ "None",
+ "AES256",
+ "RSAES_PKCS1_v_1_5"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "EncryptionAlgorithm",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Authentication": {
+ "description": "Authentication mechanism for IoT devices.",
+ "type": "object",
+ "properties": {
+ "symmetricKey": {
+ "$ref": "#/definitions/SymmetricKey",
+ "description": "Symmetric key for authentication."
+ }
+ }
+ },
+ "AzureContainerInfo": {
+ "description": "Azure container mapping of the endpoint.",
+ "required": [
+ "storageAccountCredentialId",
+ "containerName",
+ "dataFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "storageAccountCredentialId": {
+ "description": "ID of the storage account credential used to access storage.",
+ "type": "string"
+ },
+ "containerName": {
+ "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).",
+ "type": "string"
+ },
+ "dataFormat": {
+ "description": "Storage format used for the file represented by the share.",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AzureFile"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureContainerDataFormat",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "BandwidthSchedule": {
+ "description": "The bandwidth schedule details.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BandwidthScheduleProperties",
+ "description": "The properties of the bandwidth schedule.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of BandwidthSchedule",
+ "readOnly": true
+ }
+ }
+ },
+ "BandwidthScheduleProperties": {
+ "description": "The properties of the bandwidth schedule.",
+ "required": [
+ "start",
+ "stop",
+ "rateInMbps",
+ "days"
+ ],
+ "type": "object",
+ "properties": {
+ "start": {
+ "description": "The start time of the schedule in UTC.",
+ "type": "string"
+ },
+ "stop": {
+ "description": "The stop time of the schedule in UTC.",
+ "type": "string"
+ },
+ "rateInMbps": {
+ "format": "int32",
+ "description": "The bandwidth rate in Mbps.",
+ "type": "integer"
+ },
+ "days": {
+ "description": "The days of the week when this schedule is applicable.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "Sunday",
+ "Monday",
+ "Tuesday",
+ "Wednesday",
+ "Thursday",
+ "Friday",
+ "Saturday"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DayOfWeek",
+ "modelAsString": true
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ }
+ },
+ "BandwidthSchedulesList": {
+ "description": "The collection of bandwidth schedules.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of bandwidth schedules.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BandwidthSchedule"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ClientAccessRight": {
+ "description": "The mapping between a particular client IP and the type of access client has on the NFS share.",
+ "required": [
+ "client",
+ "accessPermission"
+ ],
+ "type": "object",
+ "properties": {
+ "client": {
+ "description": "IP of the client.",
+ "type": "string"
+ },
+ "accessPermission": {
+ "description": "Type of access to be allowed for the client.",
+ "enum": [
+ "NoAccess",
+ "ReadOnly",
+ "ReadWrite"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClientPermissionType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CloudEdgeManagementRole": {
+ "description": "The preview of Virtual Machine Cloud Management from the Azure supports deploying and managing VMs on your Azure Stack Edge device from Azure Portal. \r\nFor more information, refer to: https://docs.microsoft.com/en-us/azure/databox-online/azure-stack-edge-gpu-virtual-machine-overview\r\nBy using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/ for additional details.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/CloudEdgeManagementRoleProperties",
+ "description": "Properties specific to CloudEdgeManagementRole role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "CloudEdgeManagement"
+ },
+ "CloudEdgeManagementRoleProperties": {
+ "description": "CloudEdgeManagement Role properties.",
+ "required": [
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "localManagementStatus": {
+ "description": "Local Edge Management Status",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ },
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfile",
+ "description": "Edge Profile of the resource",
+ "readOnly": true
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CloudError": {
+ "description": "An error response from the service.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/CloudErrorBody",
+ "description": "The error details."
+ }
+ },
+ "x-ms-external": true
+ },
+ "CloudErrorBody": {
+ "description": "An error response from the service.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message describing the error, intended to be suitable for display in a user interface.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of additional details about the error.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-external": true
+ },
+ "ClusterCapacityViewData": {
+ "description": "Cluster Compute Data.",
+ "type": "object",
+ "properties": {
+ "fqdn": {
+ "description": "The FQDN of the cluster.",
+ "type": "string"
+ },
+ "gpuCapacity": {
+ "$ref": "#/definitions/ClusterGpuCapacity",
+ "description": "The cluster's GPU capacity."
+ },
+ "memoryCapacity": {
+ "$ref": "#/definitions/ClusterMemoryCapacity",
+ "description": "The cluster's memory capacity."
+ },
+ "lastRefreshedTime": {
+ "format": "date-time",
+ "description": "The last time at which the ClusterCapacityViewData was set.",
+ "type": "string"
+ },
+ "totalProvisionedNonHpnCores": {
+ "format": "int64",
+ "description": "The total # of vCPUs provisioned by non-HPN VM per appliance.",
+ "type": "integer"
+ }
+ }
+ },
+ "ClusterGpuCapacity": {
+ "description": "Cluster GPU Data.",
+ "type": "object",
+ "properties": {
+ "gpuType": {
+ "description": "The cluster GPU Type.",
+ "type": "string"
+ },
+ "gpuUsedUnitsCount": {
+ "format": "int32",
+ "description": "The used GPU units count in the cluster.",
+ "type": "integer"
+ },
+ "gpuFreeUnitsCount": {
+ "format": "int32",
+ "description": "The free GPU units count in the cluster.",
+ "type": "integer"
+ },
+ "gpuReservedForFailoverUnitsCount": {
+ "format": "int32",
+ "description": "The GPU units count reserved for failover in the cluster.",
+ "type": "integer"
+ },
+ "gpuTotalUnitsCount": {
+ "format": "int32",
+ "description": "The total GPU units count in the cluster.",
+ "type": "integer"
+ }
+ }
+ },
+ "ClusterMemoryCapacity": {
+ "description": "NodeCapacityInfo defines the required information to determine the placement of a VM.",
+ "type": "object",
+ "properties": {
+ "clusterFreeMemoryMb": {
+ "format": "double",
+ "description": "The free memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterUsedMemoryMb": {
+ "format": "double",
+ "description": "The used memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFailoverMemoryMb": {
+ "format": "double",
+ "description": "The failover memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFragmentationMemoryMb": {
+ "format": "double",
+ "description": "The fragmentation memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterHypervReserveMemoryMb": {
+ "format": "double",
+ "description": "The memory reserved for Hyper-V in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterInfraVmMemoryMb": {
+ "format": "double",
+ "description": "The memory of the Infra VM in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterTotalMemoryMb": {
+ "format": "double",
+ "description": "The total memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterNonFailoverVmMb": {
+ "format": "double",
+ "description": "The non-failover memory in the cluster in MB.",
+ "type": "number"
+ },
+ "clusterMemoryUsedByVmsMb": {
+ "format": "double",
+ "description": "The memory used by VMs in the cluster in MB.",
+ "type": "number"
+ }
+ }
+ },
+ "ClusterStorageViewData": {
+ "description": "Cluster Storage Data.",
+ "type": "object",
+ "properties": {
+ "clusterTotalStorageMb": {
+ "format": "double",
+ "description": "Total storage on the cluster in MB.",
+ "type": "number"
+ },
+ "clusterFreeStorageMb": {
+ "format": "double",
+ "description": "The available or free storage on the cluster in MB.",
+ "type": "number"
+ }
+ }
+ },
+ "CniConfig": {
+ "description": "Cni configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Cni type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Cni version",
+ "type": "string",
+ "readOnly": true
+ },
+ "podSubnet": {
+ "description": "Pod Subnet",
+ "type": "string",
+ "readOnly": true
+ },
+ "serviceSubnet": {
+ "description": "Service subnet",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ComputeResource": {
+ "description": "Compute infrastructure Resource",
+ "required": [
+ "processorCount",
+ "memoryInGB"
+ ],
+ "type": "object",
+ "properties": {
+ "processorCount": {
+ "format": "int32",
+ "description": "Processor count",
+ "type": "integer"
+ },
+ "memoryInGB": {
+ "format": "int64",
+ "description": "Memory in GB",
+ "type": "integer"
+ }
+ }
+ },
+ "ComputeVersionInformation": {
+ "description": "This contains the compute information",
+ "type": "object",
+ "properties": {
+ "kubernetesVersion": {
+ "description": "Kubernetes Version",
+ "type": "string"
+ },
+ "iotEdgeVersion": {
+ "description": "IOTEdge Version",
+ "type": "string"
+ },
+ "azureArcVersion": {
+ "description": "Azure Arc Version",
+ "type": "string"
+ }
+ }
+ },
+ "ContactDetails": {
+ "description": "Contains all the contact details of the customer.",
+ "required": [
+ "contactPerson",
+ "companyName",
+ "phone",
+ "emailList"
+ ],
+ "type": "object",
+ "properties": {
+ "contactPerson": {
+ "description": "The contact person name.",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "The phone number.",
+ "type": "string"
+ },
+ "emailList": {
+ "description": "The email list.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "Container": {
+ "description": "Represents a container on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ContainerProperties",
+ "description": "The container properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Container",
+ "readOnly": true
+ }
+ }
+ },
+ "ContainerList": {
+ "description": "Collection of all the containers on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of containers.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Container"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ContainerProperties": {
+ "description": "The container properties.",
+ "required": [
+ "dataFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "containerStatus": {
+ "description": "Current status of the container.",
+ "enum": [
+ "OK",
+ "Offline",
+ "Unknown",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ContainerStatus",
+ "modelAsString": true
+ }
+ },
+ "dataFormat": {
+ "description": "DataFormat for Container",
+ "enum": [
+ "BlockBlob",
+ "PageBlob",
+ "AzureFile"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureContainerDataFormat",
+ "modelAsString": true
+ }
+ },
+ "refreshDetails": {
+ "$ref": "#/definitions/RefreshDetails",
+ "description": "Details of the refresh job on this container.",
+ "readOnly": true
+ },
+ "createdDateTime": {
+ "format": "date-time",
+ "description": "The UTC time when container got created.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevice": {
+ "description": "The Data Box Edge/Gateway device.",
+ "required": [
+ "location"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.",
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU type."
+ },
+ "etag": {
+ "description": "The etag for the devices.",
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ },
+ "kind": {
+ "description": "The kind of the device.",
+ "enum": [
+ "AzureDataBoxGateway",
+ "AzureStackEdge",
+ "AzureStackHub",
+ "AzureModularDataCentre"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataBoxEdgeDeviceKind",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "DataBoxEdge Resource",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceProperties",
+ "description": "The properties of the Data Box Edge/Gateway device.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfo": {
+ "description": "The extended Info of the Data Box Edge/Gateway device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties",
+ "description": "The extended info properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of DataBoxEdgeDevice",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfoPatch": {
+ "description": "The Data Box Edge/Gateway device extended info patch.",
+ "type": "object",
+ "properties": {
+ "clientSecretStoreId": {
+ "description": "The Key Vault ARM Id for client secrets",
+ "type": "string"
+ },
+ "clientSecretStoreUrl": {
+ "description": "The url to access the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyName": {
+ "description": "The name for Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyVersion": {
+ "description": "The version of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "syncStatus": {
+ "description": "For changing or to initiate the resync to key-vault set the status to KeyVaultSyncPending, rest of the status will not be applicable.",
+ "enum": [
+ "KeyVaultSynced",
+ "KeyVaultSyncFailed",
+ "KeyVaultNotConfigured",
+ "KeyVaultSyncPending",
+ "KeyVaultSyncing",
+ "KeyVaultNotSynced"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyVaultSyncStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DataBoxEdgeDeviceExtendedInfoProperties": {
+ "description": "The properties of the Data Box Edge/Gateway device extended info.",
+ "type": "object",
+ "properties": {
+ "encryptionKeyThumbprint": {
+ "description": "The digital signature of encrypted certificate.",
+ "type": "string"
+ },
+ "encryptionKey": {
+ "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.",
+ "type": "string"
+ },
+ "resourceKey": {
+ "description": "The Resource ID of the Resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "clientSecretStoreId": {
+ "description": "The Key Vault ARM Id for client secrets",
+ "type": "string"
+ },
+ "clientSecretStoreUrl": {
+ "description": "The url to access the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyName": {
+ "description": "The name of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "channelIntegrityKeyVersion": {
+ "description": "The version of Channel Integrity Key stored in the Client Key Vault",
+ "type": "string"
+ },
+ "keyVaultSyncStatus": {
+ "description": "Key vault sync status",
+ "enum": [
+ "KeyVaultSynced",
+ "KeyVaultSyncFailed",
+ "KeyVaultNotConfigured",
+ "KeyVaultSyncPending",
+ "KeyVaultSyncing",
+ "KeyVaultNotSynced"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "KeyVaultSyncStatus",
+ "modelAsString": true
+ }
+ },
+ "deviceSecrets": {
+ "description": "Device secrets, will be returned only with ODataFilter $expand=deviceSecrets",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/Secret"
+ },
+ "readOnly": true
+ },
+ "clusterWitnessType": {
+ "description": "Cluster Witness Type",
+ "enum": [
+ "None",
+ "Cloud",
+ "FileShare"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ClusterWitnessType",
+ "modelAsString": true
+ }
+ },
+ "fileShareWitnessLocation": {
+ "description": "The witness location of file share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "fileShareWitnessUsername": {
+ "description": "The username of file share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessStorageAccountName": {
+ "description": "The Cloud Witness Storage account name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessContainerName": {
+ "description": "The Container for cloud witness in the storage account.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cloudWitnessStorageEndpoint": {
+ "description": "The Azure service endpoint of the cloud witness storage account.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceList": {
+ "description": "The collection of Data Box Edge/Gateway devices.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of Data Box Edge/Gateway devices.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxEdgeDevice"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevicePatch": {
+ "description": "The Data Box Edge/Gateway device patch.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "The tags attached to the Data Box Edge/Gateway resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "identity": {
+ "$ref": "#/definitions/ResourceIdentity",
+ "description": "Msi identity of the resource"
+ },
+ "properties": {
+ "$ref": "#/definitions/DataBoxEdgeDevicePropertiesPatch",
+ "description": "The properties associated with the Data Box Edge/Gateway resource",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DataBoxEdgeDeviceProperties": {
+ "description": "The properties of the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "DataBoxEdge Device Properties",
+ "readOnly": true
+ },
+ "dataBoxEdgeDeviceStatus": {
+ "description": "The status of the Data Box Edge/Gateway device.",
+ "enum": [
+ "ReadyToSetup",
+ "Online",
+ "Offline",
+ "NeedsAttention",
+ "Disconnected",
+ "PartiallyDisconnected",
+ "Maintenance"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DataBoxEdgeDeviceStatus",
+ "modelAsString": true
+ }
+ },
+ "serialNumber": {
+ "description": "The Serial Number of Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "The Description of the Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "modelDescription": {
+ "description": "The description of the Data Box Edge/Gateway device model.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceType": {
+ "description": "The type of the Data Box Edge/Gateway device.",
+ "enum": [
+ "DataBoxEdgeDevice"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DeviceType",
+ "modelAsString": true
+ }
+ },
+ "friendlyName": {
+ "description": "The Data Box Edge/Gateway device name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "culture": {
+ "description": "The Data Box Edge/Gateway device culture.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceModel": {
+ "description": "The Data Box Edge/Gateway device model.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceSoftwareVersion": {
+ "description": "The Data Box Edge/Gateway device software version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceLocalCapacity": {
+ "format": "int64",
+ "description": "The Data Box Edge/Gateway device local capacity in MB.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "timeZone": {
+ "description": "The Data Box Edge/Gateway device timezone.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deviceHcsVersion": {
+ "description": "The device software version number of the device (eg: 1.2.18105.6).",
+ "type": "string",
+ "readOnly": true
+ },
+ "configuredRoleTypes": {
+ "description": "Type of compute roles configured.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ },
+ "x-ms-identifiers": []
+ },
+ "readOnly": true
+ },
+ "nodeCount": {
+ "format": "int32",
+ "description": "The number of nodes in the cluster.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "resourceMoveDetails": {
+ "$ref": "#/definitions/ResourceMoveDetails",
+ "description": "The details of the move operation on this resource.",
+ "readOnly": true
+ },
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfile",
+ "description": "The details of Edge Profile for this resource",
+ "readOnly": true
+ },
+ "dataResidency": {
+ "$ref": "#/definitions/DataResidency",
+ "description": "The details of data-residency related properties for this resource"
+ },
+ "computeVersionInformation": {
+ "$ref": "#/definitions/ComputeVersionInformation",
+ "description": "The details of compute version information",
+ "readOnly": true
+ },
+ "kubernetesPlatform": {
+ "description": "Type of Kubernetes Platform",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeDevicePropertiesPatch": {
+ "description": "The Data Box Edge/Gateway device properties patch.",
+ "type": "object",
+ "properties": {
+ "edgeProfile": {
+ "$ref": "#/definitions/EdgeProfilePatch",
+ "description": "Edge Profile property of the Data Box Edge/Gateway device"
+ }
+ }
+ },
+ "DataBoxEdgeMoveRequest": {
+ "description": "Resource Move details",
+ "required": [
+ "targetResourceGroup",
+ "resources"
+ ],
+ "type": "object",
+ "properties": {
+ "targetResourceGroup": {
+ "description": "Target resource group ARMId",
+ "type": "string"
+ },
+ "resources": {
+ "description": "List of resources to be moved",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "DataBoxEdgeSku": {
+ "description": "The Sku information.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "The type of the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The Sku name.",
+ "enum": [
+ "Gateway",
+ "Edge",
+ "TEA_1Node",
+ "TEA_1Node_UPS",
+ "TEA_1Node_Heater",
+ "TEA_1Node_UPS_Heater",
+ "TEA_4Node_Heater",
+ "TEA_4Node_UPS_Heater",
+ "TMA",
+ "TDC",
+ "TCA_Small",
+ "GPU",
+ "TCA_Large",
+ "EdgeP_Base",
+ "EdgeP_High",
+ "EdgePR_Base",
+ "EdgePR_Base_UPS",
+ "EP2_64_1VPU_W",
+ "EP2_128_1T4_Mx1_W",
+ "EP2_256_2T4_W",
+ "EdgeMR_Mini",
+ "RCA_Small",
+ "RCA_Large",
+ "RDC",
+ "Management",
+ "EP2_64_Mx1_W",
+ "EP2_128_GPU1_Mx1_W",
+ "EP2_256_GPU2_Mx1",
+ "EdgeMR_TCP"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "kind": {
+ "description": "The Sku kind.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tier": {
+ "description": "The Sku tier.",
+ "enum": [
+ "Standard"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ },
+ "size": {
+ "description": "The Sku kind.",
+ "type": "string",
+ "readOnly": true
+ },
+ "family": {
+ "description": "The Sku family.",
+ "type": "string",
+ "readOnly": true
+ },
+ "locations": {
+ "description": "Availability of the Sku for the region.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "apiVersions": {
+ "description": "The API versions in which Sku is available.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "locationInfo": {
+ "description": "Availability of the Sku for the location/zone/site.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuLocationInfo"
+ },
+ "x-ms-identifiers": [
+ "location"
+ ],
+ "readOnly": true
+ },
+ "costs": {
+ "description": "The pricing info of the Sku.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCost"
+ },
+ "x-ms-identifiers": [
+ "meterId"
+ ],
+ "readOnly": true
+ },
+ "signupOption": {
+ "description": "Sku can be signed up by customer or not.",
+ "enum": [
+ "None",
+ "Available"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuSignupOption",
+ "modelAsString": true
+ }
+ },
+ "version": {
+ "description": "Availability of the Sku as preview/stable.",
+ "enum": [
+ "Stable",
+ "Preview"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuVersion",
+ "modelAsString": true
+ }
+ },
+ "availability": {
+ "description": "Links to the next set of results",
+ "enum": [
+ "Available",
+ "Unavailable"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SkuAvailability",
+ "modelAsString": true
+ }
+ },
+ "shipmentTypes": {
+ "description": "List of Shipment Types supported by this SKU",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "NotApplicable",
+ "ShippedToCustomer",
+ "SelfPickup"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShipmentType",
+ "modelAsString": true
+ }
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "capabilities": {
+ "description": "The capability info of the SKU.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuCapability"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "readOnly": true
+ }
+ }
+ },
+ "DataBoxEdgeSkuList": {
+ "description": "List of SKU Information objects.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of ResourceType Sku",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataBoxEdgeSku"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "resourceType"
+ ],
+ "readOnly": true
+ },
+ "nextLink": {
+ "description": "Links to the next set of results",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DataResidency": {
+ "description": "Wraps data-residency related information for edge-resource and this should be used with ARM layer.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "DataResidencyType enum",
+ "enum": [
+ "GeoZoneReplication",
+ "ZoneReplication"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataResidencyType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DCAccessCode": {
+ "description": "DC Access code in the case of Self Managed Shipping.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DCAccessCodeProperties",
+ "description": "DCAccessCode properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DCAccessCodeProperties": {
+ "description": "DCAccessCode Properties.",
+ "type": "object",
+ "properties": {
+ "authCode": {
+ "description": "DCAccess Code for the Self Managed shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "DeviceCapacityInfo": {
+ "description": "Object for Capturing DeviceCapacityInfo",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeviceCapacityInfoProperties",
+ "description": "The device capacity properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to device capacity info.",
+ "readOnly": true
+ }
+ }
+ },
+ "DeviceCapacityInfoProperties": {
+ "description": "The properties of Device Capacity Info",
+ "type": "object",
+ "properties": {
+ "timeStamp": {
+ "format": "date-time",
+ "description": "Timestamp of request in UTC",
+ "type": "string"
+ },
+ "clusterStorageCapacityInfo": {
+ "$ref": "#/definitions/ClusterStorageViewData",
+ "description": "Cluster capacity data for storage resources (CSV)."
+ },
+ "clusterComputeCapacityInfo": {
+ "$ref": "#/definitions/ClusterCapacityViewData",
+ "description": "Cluster capacity data for compute resources (Memory and GPU)."
+ },
+ "nodeCapacityInfos": {
+ "description": "The dictionary of individual node names and node capacities in the cluster.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/HostCapacity"
+ }
+ }
+ }
+ },
+ "DeviceCapacityRequestInfo": {
+ "description": "Object for Capturing DeviceCapacityRequestInfo",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeviceCapacityRequestInfoProperties",
+ "description": "The properties of the Device Capacity Request.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DeviceCapacityRequestInfoProperties": {
+ "description": "Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.",
+ "required": [
+ "vmPlacementQuery"
+ ],
+ "type": "object",
+ "properties": {
+ "vmPlacementQuery": {
+ "description": "Array containing the sizes of the VMs for checking if its feasible to create them on the appliance.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "x-ms-identifiers": []
+ },
+ "vmPlacementResults": {
+ "description": "Array of the VMs of the sizes in VmSizes can be provisioned on the appliance.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VmPlacementRequestResult"
+ },
+ "x-ms-identifiers": []
+ },
+ "deviceCapacityRequestType": {
+ "type": "string",
+ "description": "Flag to check the type of capacity check on the appliance.",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticProactiveLogCollectionSettings": {
+ "description": "The diagnostic proactive log collection settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ProactiveLogCollectionSettingsProperties",
+ "description": "Properties of the diagnostic proactive log collection settings.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of DiagnosticProactiveLogCollectionSettings",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticRemoteSupportSettings": {
+ "description": "The remote support settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DiagnosticRemoteSupportSettingsProperties",
+ "description": "Properties of the remote support settings.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Represents resource creation and updation time",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticRemoteSupportSettingsProperties": {
+ "description": "The properties of remote support settings.",
+ "type": "object",
+ "properties": {
+ "remoteSupportSettingsList": {
+ "description": "Remote support settings list according to the RemoteApplicationType",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RemoteSupportSettings"
+ },
+ "x-ms-identifiers": [
+ "remoteApplicationType"
+ ]
+ }
+ }
+ },
+ "EdgeProfile": {
+ "description": "Details about Edge Profile for the resource",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "$ref": "#/definitions/EdgeProfileSubscription",
+ "description": "Edge Profile Subscription"
+ }
+ }
+ },
+ "EdgeProfilePatch": {
+ "description": "The Data Box Edge/Gateway Edge Profile patch.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "$ref": "#/definitions/EdgeProfileSubscriptionPatch",
+ "description": "The Data Box Edge/Gateway Edge Profile Subscription patch"
+ }
+ }
+ },
+ "EdgeProfileSubscription": {
+ "description": "Subscription details for the Edge Profile",
+ "type": "object",
+ "properties": {
+ "registrationId": {
+ "description": "Edge Subscription Registration ID",
+ "type": "string"
+ },
+ "id": {
+ "description": "ARM ID of the subscription",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "Registered",
+ "Warned",
+ "Suspended",
+ "Deleted",
+ "Unregistered"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SubscriptionState",
+ "modelAsString": true
+ }
+ },
+ "registrationDate": {
+ "type": "string"
+ },
+ "subscriptionId": {
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/SubscriptionProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "EdgeProfileSubscriptionPatch": {
+ "description": "The Data Box Edge/Gateway Edge Profile Subscription patch.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the subscription of the edge profile.",
+ "type": "string"
+ }
+ }
+ },
+ "EtcdInfo": {
+ "description": "Etcd configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Etcd type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Etcd version",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "FileEventTrigger": {
+ "description": "Trigger details.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Trigger"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/FileTriggerProperties",
+ "description": "File trigger properties.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "FileEvent"
+ },
+ "FileSourceInfo": {
+ "description": "File source details.",
+ "required": [
+ "shareId"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "File share ID.",
+ "type": "string"
+ }
+ }
+ },
+ "FileTriggerProperties": {
+ "description": "File trigger properties.",
+ "required": [
+ "sourceInfo",
+ "sinkInfo"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceInfo": {
+ "$ref": "#/definitions/FileSourceInfo",
+ "description": "File event source details."
+ },
+ "sinkInfo": {
+ "$ref": "#/definitions/RoleSinkInfo",
+ "description": "Role sink info."
+ },
+ "customContextTag": {
+ "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
+ "maxLength": 192,
+ "type": "string"
+ }
+ }
+ },
+ "GenerateCertResponse": {
+ "description": "Used in activation key generation flow.",
+ "type": "object",
+ "properties": {
+ "publicKey": {
+ "description": "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "expiryTimeInUTC": {
+ "description": "Gets or sets expiry time in UTC",
+ "type": "string"
+ }
+ }
+ },
+ "HostCapacity": {
+ "description": "Host Capacity Data.",
+ "type": "object",
+ "properties": {
+ "hostName": {
+ "description": "The name of the host.",
+ "type": "string"
+ },
+ "effectiveAvailableMemoryMbOnHost": {
+ "format": "int64",
+ "description": "The available memory on the host accounting for VM placement size and any host VM reservations.",
+ "type": "integer"
+ },
+ "availableGpuCount": {
+ "format": "int32",
+ "description": "The available amount of GPUs on the host to use after accounting for GPUS used by reservations on the host.",
+ "type": "integer"
+ },
+ "vmUsedMemory": {
+ "description": "The VM used memory per VmId.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/VmMemory"
+ }
+ },
+ "gpuType": {
+ "description": "The GPU type of the VM.",
+ "type": "string"
+ },
+ "numaNodesData": {
+ "description": "The numa nodes information for Hpn VMs.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NumaNodeData"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ImageRepositoryCredential": {
+ "description": "Image repository credential.",
+ "required": [
+ "imageRepositoryUrl",
+ "userName"
+ ],
+ "type": "object",
+ "properties": {
+ "imageRepositoryUrl": {
+ "description": "Image repository url (e.g.: mcr.microsoft.com).",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Repository user name.",
+ "type": "string"
+ },
+ "password": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Repository user password."
+ }
+ }
+ },
+ "IoTDeviceInfo": {
+ "description": "Metadata of IoT device/IoT Edge device to be configured.",
+ "required": [
+ "deviceId",
+ "ioTHostHub"
+ ],
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "ID of the IoT device/edge device.",
+ "type": "string"
+ },
+ "ioTHostHub": {
+ "description": "Host name for the IoT hub associated to the device.",
+ "type": "string"
+ },
+ "ioTHostHubId": {
+ "description": "Id for the IoT hub associated to the device.",
+ "type": "string"
+ },
+ "authentication": {
+ "$ref": "#/definitions/Authentication",
+ "description": "Encrypted IoT device/IoT edge device connection string."
+ }
+ }
+ },
+ "IoTEdgeAgentInfo": {
+ "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.",
+ "required": [
+ "imageName",
+ "tag"
+ ],
+ "type": "object",
+ "properties": {
+ "imageName": {
+ "description": "Name of the IoT edge agent image.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Image Tag.",
+ "type": "string"
+ },
+ "imageRepository": {
+ "$ref": "#/definitions/ImageRepositoryCredential",
+ "description": "Image repository details."
+ }
+ }
+ },
+ "IoTRole": {
+ "description": "Compute role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/IoTRoleProperties",
+ "description": "Properties specific to IoT role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "IOT"
+ },
+ "IoTRoleProperties": {
+ "description": "IoT role properties.",
+ "required": [
+ "hostPlatform",
+ "ioTDeviceDetails",
+ "ioTEdgeDeviceDetails",
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "hostPlatform": {
+ "description": "Host OS supported by the IoT role.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "ioTDeviceDetails": {
+ "$ref": "#/definitions/IoTDeviceInfo",
+ "description": "IoT device metadata to which data box edge device needs to be connected."
+ },
+ "ioTEdgeDeviceDetails": {
+ "$ref": "#/definitions/IoTDeviceInfo",
+ "description": "IoT edge device to which the IoT role needs to be configured."
+ },
+ "shareMappings": {
+ "description": "Mount points of shares in role(s).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ]
+ },
+ "ioTEdgeAgentInfo": {
+ "$ref": "#/definitions/IoTEdgeAgentInfo",
+ "description": "Iot edge agent details to download the agent and bootstrap iot runtime."
+ },
+ "hostPlatformType": {
+ "description": "Platform where the Iot runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "computeResource": {
+ "$ref": "#/definitions/ComputeResource",
+ "description": "Resource allocation"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Ipv4Config": {
+ "description": "Details related to the IPv4 address configuration.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IPv4 address of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subnet": {
+ "description": "The IPv4 subnet of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "gateway": {
+ "description": "The IPv4 gateway of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Ipv6Config": {
+ "description": "Details related to the IPv6 address configuration.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IPv6 address of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "prefixLength": {
+ "format": "int32",
+ "description": "The IPv6 prefix of the network adapter.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "gateway": {
+ "description": "The IPv6 gateway of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Job": {
+ "description": "A device job.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The name of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The current status of the job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "The UTC date and time at which the job started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "The UTC date and time at which the job completed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "percentComplete": {
+ "format": "int32",
+ "description": "The percentage of the job that is complete.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "error": {
+ "$ref": "#/definitions/JobErrorDetails",
+ "description": "The error details.",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/JobProperties",
+ "description": "The properties of the job.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "JobErrorDetails": {
+ "description": "The job error information containing the list of job errors.",
+ "type": "object",
+ "properties": {
+ "errorDetails": {
+ "description": "The error details.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/JobErrorItem"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "code": {
+ "description": "The code intended for programmatic access.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The message that describes the error in detail.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "JobErrorItem": {
+ "description": "The job error items.",
+ "type": "object",
+ "properties": {
+ "recommendations": {
+ "description": "The recommended actions.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "code": {
+ "description": "The code intended for programmatic access.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "The message that describes the error in detail.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "JobProperties": {
+ "description": "The properties for the job.",
+ "type": "object",
+ "properties": {
+ "jobType": {
+ "description": "The type of the job.",
+ "enum": [
+ "Invalid",
+ "ScanForUpdates",
+ "DownloadUpdates",
+ "InstallUpdates",
+ "RefreshShare",
+ "RefreshContainer",
+ "Backup",
+ "Restore",
+ "TriggerSupportPackage"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobType",
+ "modelAsString": true
+ }
+ },
+ "currentStage": {
+ "description": "Current stage of the update operation.",
+ "enum": [
+ "Unknown",
+ "Initial",
+ "ScanStarted",
+ "ScanComplete",
+ "ScanFailed",
+ "DownloadStarted",
+ "DownloadComplete",
+ "DownloadFailed",
+ "InstallStarted",
+ "InstallComplete",
+ "InstallFailed",
+ "RebootInitiated",
+ "Success",
+ "Failure",
+ "RescanStarted",
+ "RescanComplete",
+ "RescanFailed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "UpdateOperationStage",
+ "modelAsString": true
+ }
+ },
+ "downloadProgress": {
+ "$ref": "#/definitions/UpdateDownloadProgress",
+ "description": "The download progress.",
+ "readOnly": true
+ },
+ "installProgress": {
+ "$ref": "#/definitions/UpdateInstallProgress",
+ "description": "The install progress.",
+ "readOnly": true
+ },
+ "totalRefreshErrors": {
+ "format": "int32",
+ "description": "Total number of errors encountered during the refresh process.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "errorManifestFile": {
+ "description": "Local share/remote container relative path to the error manifest file of the refresh.",
+ "type": "string",
+ "readOnly": true
+ },
+ "refreshedEntityId": {
+ "description": "ARM ID of the entity that was refreshed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "folder": {
+ "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)",
+ "type": "string"
+ }
+ }
+ },
+ "KubernetesClusterInfo": {
+ "description": "Kubernetes cluster configuration",
+ "required": [
+ "version"
+ ],
+ "type": "object",
+ "properties": {
+ "etcdInfo": {
+ "$ref": "#/definitions/EtcdInfo",
+ "description": "Etcd configuration",
+ "readOnly": true
+ },
+ "nodes": {
+ "description": "Kubernetes cluster nodes",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NodeInfo"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "readOnly": true
+ },
+ "version": {
+ "description": "Kubernetes cluster version",
+ "type": "string"
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KubernetesIPConfiguration": {
+ "description": "Kubernetes node IP configuration",
+ "type": "object",
+ "properties": {
+ "port": {
+ "description": "Port of the Kubernetes node.",
+ "type": "string",
+ "readOnly": true
+ },
+ "ipAddress": {
+ "description": "IP address of the Kubernetes node.",
+ "type": "string"
+ }
+ }
+ },
+ "KubernetesRole": {
+ "description": "The limited preview of Kubernetes Cluster Management from the Azure supports:\r\n1. Using a simple turn-key option in Azure Portal, deploy a Kubernetes cluster on your Azure Stack Edge device. \r\n2. Configure Kubernetes cluster running on your device with Arc enabled Kubernetes with a click of a button in the Azure Portal. \r\n Azure Arc enables organizations to view, manage, and govern their on-premises Kubernetes clusters using the Azure Portal, command line tools, and APIs.\r\n3. Easily configure Persistent Volumes using SMB and NFS shares for storing container data. \r\n For more information, refer to the document here: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8-Cloud-Management-20210323.pdf \r\n Or Demo: https://databoxupdatepackages.blob.core.windows.net/documentation/Microsoft-Azure-Stack-Edge-K8S-Cloud-Management-20210323.mp4\r\n By using this feature, you agree to the preview legal terms. See the https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/KubernetesRoleProperties",
+ "description": "Properties specific to Kubernetes role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "Kubernetes"
+ },
+ "KubernetesRoleCompute": {
+ "description": "Kubernetes role compute resource",
+ "required": [
+ "vmProfile"
+ ],
+ "type": "object",
+ "properties": {
+ "vmProfile": {
+ "description": "VM profile",
+ "type": "string"
+ },
+ "memoryInBytes": {
+ "format": "int64",
+ "description": "Memory in bytes",
+ "type": "integer",
+ "readOnly": true
+ },
+ "processorCount": {
+ "format": "int32",
+ "description": "Processor count",
+ "type": "integer",
+ "readOnly": true
+ },
+ "hugePage2M": {
+ "format": "int32",
+ "description": "Count of huge pages",
+ "type": "integer",
+ "readOnly": true
+ },
+ "hugePage1G": {
+ "format": "int32",
+ "description": "Count of huge pages",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleNetwork": {
+ "description": "Kubernetes role network resource",
+ "type": "object",
+ "properties": {
+ "cniConfig": {
+ "$ref": "#/definitions/CniConfig",
+ "description": "Cni configuration",
+ "readOnly": true
+ },
+ "loadBalancerConfig": {
+ "$ref": "#/definitions/LoadBalancerConfig",
+ "description": "Load balancer configuration",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleProperties": {
+ "description": "Kubernetes role properties.",
+ "required": [
+ "hostPlatform",
+ "kubernetesClusterInfo",
+ "kubernetesRoleResources",
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "hostPlatform": {
+ "description": "Host OS supported by the Kubernetes role.",
+ "enum": [
+ "Windows",
+ "Linux"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PlatformType",
+ "modelAsString": true
+ }
+ },
+ "provisioningState": {
+ "description": "State of Kubernetes deployment",
+ "enum": [
+ "Invalid",
+ "Creating",
+ "Created",
+ "Updating",
+ "Reconfiguring",
+ "Failed",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesState",
+ "modelAsString": true
+ }
+ },
+ "hostPlatformType": {
+ "description": "Platform where the runtime is hosted.",
+ "enum": [
+ "KubernetesCluster",
+ "LinuxVM"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostPlatformType",
+ "modelAsString": true
+ }
+ },
+ "kubernetesClusterInfo": {
+ "$ref": "#/definitions/KubernetesClusterInfo",
+ "description": "Kubernetes cluster configuration"
+ },
+ "kubernetesRoleResources": {
+ "$ref": "#/definitions/KubernetesRoleResources",
+ "description": "Kubernetes role resources"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "KubernetesRoleResources": {
+ "description": "Kubernetes role resources",
+ "required": [
+ "compute"
+ ],
+ "type": "object",
+ "properties": {
+ "storage": {
+ "$ref": "#/definitions/KubernetesRoleStorage",
+ "description": "Kubernetes role storage resource"
+ },
+ "compute": {
+ "$ref": "#/definitions/KubernetesRoleCompute",
+ "description": "Kubernetes role compute resource"
+ },
+ "network": {
+ "$ref": "#/definitions/KubernetesRoleNetwork",
+ "description": "Kubernetes role network resource",
+ "readOnly": true
+ }
+ }
+ },
+ "KubernetesRoleStorage": {
+ "description": "Kubernetes role storage resource",
+ "type": "object",
+ "properties": {
+ "storageClasses": {
+ "description": "Kubernetes storage class info.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/KubernetesRoleStorageClassInfo"
+ },
+ "x-ms-identifiers": [
+ "name",
+ "type"
+ ],
+ "readOnly": true
+ },
+ "endpoints": {
+ "description": "Mount points of shares in role(s).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ]
+ }
+ }
+ },
+ "KubernetesRoleStorageClassInfo": {
+ "description": "Kubernetes storage class info.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Storage class name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Storage class type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "posixCompliant": {
+ "description": "If provisioned storage is posix compliant.",
+ "enum": [
+ "Invalid",
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "PosixComplianceStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "LoadBalancerConfig": {
+ "description": "Load balancer configuration",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Load balancer type",
+ "type": "string",
+ "readOnly": true
+ },
+ "version": {
+ "description": "Load balancer version",
+ "type": "string",
+ "readOnly": true
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "MarketplaceImageOffer": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageOfferProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageOfferList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageOffer"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageOfferProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "provisioningState": {
+ "type": "string"
+ },
+ "skuMappings": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuMapping"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MarketplaceImagePublisher": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImagePublisherProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImagePublisherList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImagePublisher"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImagePublisherProperties": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceImageSku": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageSkuProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageSkuList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageSku"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageSkuProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "offerId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "skuMappings": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuMapping"
+ },
+ "x-ms-identifiers": []
+ },
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceImageVersion": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MarketplaceImageVersionProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MarketplaceImageVersionList": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MarketplaceImageVersion"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MarketplaceImageVersionProperties": {
+ "type": "object",
+ "properties": {
+ "publisherId": {
+ "type": "string"
+ },
+ "offerId": {
+ "type": "string"
+ },
+ "skuId": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentVersion": {
+ "type": "string"
+ },
+ "provisioningState": {
+ "type": "string"
+ }
+ }
+ },
+ "MarketplaceSasToken": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "sasUri": {
+ "type": "string",
+ "x-ms-secret": true
+ }
+ }
+ },
+ "MECRole": {
+ "description": "MEC role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Role"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MECRoleProperties",
+ "description": "Properties specific to MEC role.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "MEC"
+ },
+ "MECRoleProperties": {
+ "description": "MEC role properties.",
+ "required": [
+ "roleStatus"
+ ],
+ "type": "object",
+ "properties": {
+ "connectionString": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Activation key of the MEC."
+ },
+ "controllerEndpoint": {
+ "description": "Controller Endpoint.",
+ "type": "string"
+ },
+ "resourceUniqueId": {
+ "description": "Unique Id of the Resource.",
+ "type": "string"
+ },
+ "roleStatus": {
+ "description": "Role status.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "MetricConfiguration": {
+ "description": "Metric configuration.",
+ "required": [
+ "resourceId",
+ "counterSets"
+ ],
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "The Resource ID on which the metrics should be pushed.",
+ "type": "string"
+ },
+ "mdmAccount": {
+ "description": "The MDM account to which the counters should be pushed.",
+ "type": "string"
+ },
+ "metricNameSpace": {
+ "description": "The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified",
+ "type": "string"
+ },
+ "counterSets": {
+ "description": "Host name for the IoT hub associated to the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricCounterSet"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MetricCounter": {
+ "description": "The metric counter",
+ "required": [
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The counter name.",
+ "type": "string"
+ },
+ "instance": {
+ "description": "The instance from which counter should be collected.",
+ "type": "string"
+ },
+ "dimensionFilter": {
+ "description": "The dimension filter.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension"
+ },
+ "x-ms-identifiers": [
+ "sourceName"
+ ]
+ },
+ "additionalDimensions": {
+ "description": "The additional dimensions to be added to metric.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension"
+ },
+ "x-ms-identifiers": [
+ "sourceName"
+ ]
+ }
+ }
+ },
+ "MetricCounterSet": {
+ "description": "The metric counter set",
+ "required": [
+ "counters"
+ ],
+ "type": "object",
+ "properties": {
+ "counters": {
+ "description": "The counters that should be collected in this set.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricCounter"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "MetricDimension": {
+ "description": "The metric dimension",
+ "required": [
+ "sourceType",
+ "sourceName"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceType": {
+ "description": "The dimension type.",
+ "type": "string"
+ },
+ "sourceName": {
+ "description": "The dimension value.",
+ "type": "string"
+ }
+ }
+ },
+ "MetricDimension_V1": {
+ "description": "Metric Dimension v1.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metrics dimension.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Display name of the metrics dimension.",
+ "type": "string"
+ },
+ "toBeExportedForShoebox": {
+ "description": "To be exported to shoe box.",
+ "type": "boolean"
+ }
+ }
+ },
+ "MetricSpecification_V1": {
+ "description": "Metric specification version 1.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metric.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Display name of the metric.",
+ "type": "string"
+ },
+ "displayDescription": {
+ "description": "Description of the metric to be displayed.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Metric units.",
+ "enum": [
+ "NotSpecified",
+ "Percent",
+ "Count",
+ "Seconds",
+ "Milliseconds",
+ "Bytes",
+ "BytesPerSecond",
+ "CountPerSecond"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricUnit",
+ "modelAsString": true
+ }
+ },
+ "aggregationType": {
+ "description": "Metric aggregation type.",
+ "enum": [
+ "NotSpecified",
+ "None",
+ "Average",
+ "Minimum",
+ "Maximum",
+ "Total",
+ "Count"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricAggregationType",
+ "modelAsString": true
+ }
+ },
+ "dimensions": {
+ "description": "Metric dimensions, other than default dimension which is resource.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricDimension_V1"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "fillGapWithZero": {
+ "description": "Set true to fill the gaps with zero.",
+ "type": "boolean"
+ },
+ "category": {
+ "description": "Metric category.",
+ "enum": [
+ "Capacity",
+ "Transaction"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricCategory",
+ "modelAsString": true
+ }
+ },
+ "resourceIdDimensionNameOverride": {
+ "description": "Resource name override.",
+ "type": "string"
+ },
+ "supportedTimeGrainTypes": {
+ "description": "Support granularity of metrics.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "PT1M",
+ "PT5M",
+ "PT15M",
+ "PT30M",
+ "PT1H",
+ "PT6H",
+ "PT12H",
+ "PT1D"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TimeGrain",
+ "modelAsString": true
+ }
+ }
+ },
+ "supportedAggregationTypes": {
+ "description": "Support metric aggregation type.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "enum": [
+ "NotSpecified",
+ "None",
+ "Average",
+ "Minimum",
+ "Maximum",
+ "Total",
+ "Count"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MetricAggregationType",
+ "modelAsString": true
+ }
+ }
+ }
+ }
+ },
+ "MonitoringMetricConfiguration": {
+ "description": "The metric setting details for the role",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MonitoringMetricConfigurationProperties",
+ "description": "The metric setting properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of MonitoringConfiguration",
+ "readOnly": true
+ }
+ }
+ },
+ "MonitoringMetricConfigurationList": {
+ "description": "Collection of metric configurations.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of metric configurations.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MonitoringMetricConfiguration"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MonitoringMetricConfigurationProperties": {
+ "description": "Metrics properties",
+ "required": [
+ "metricConfigurations"
+ ],
+ "type": "object",
+ "properties": {
+ "metricConfigurations": {
+ "description": "The metrics configuration details",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricConfiguration"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "MountPointMap": {
+ "description": "The share mount point.",
+ "required": [
+ "shareId"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "ID of the share mounted to the role VM.",
+ "type": "string"
+ },
+ "roleId": {
+ "description": "ID of the role to which share is mounted.",
+ "type": "string",
+ "readOnly": true
+ },
+ "mountPoint": {
+ "description": "Mount point for the share.",
+ "type": "string",
+ "readOnly": true
+ },
+ "mountType": {
+ "description": "Mounting type.",
+ "enum": [
+ "Volume",
+ "HostPath"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "MountType",
+ "modelAsString": true
+ }
+ },
+ "roleType": {
+ "description": "Role type.",
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "NetworkAdapter": {
+ "description": "Represents the networkAdapter on a device.",
+ "type": "object",
+ "properties": {
+ "adapterId": {
+ "description": "Instance ID of network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "adapterPosition": {
+ "$ref": "#/definitions/NetworkAdapterPosition",
+ "description": "Hardware position of network adapter.",
+ "readOnly": true
+ },
+ "index": {
+ "format": "int32",
+ "description": "Logical index of the adapter.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "nodeId": {
+ "description": "Node ID of the network adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "networkAdapterName": {
+ "description": "Network adapter name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "label": {
+ "description": "Hardware label for the adapter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "macAddress": {
+ "description": "MAC address.",
+ "type": "string",
+ "readOnly": true
+ },
+ "linkSpeed": {
+ "format": "int64",
+ "description": "Link speed.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "status": {
+ "description": "Value indicating whether this adapter is valid.",
+ "enum": [
+ "Inactive",
+ "Active"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NetworkAdapterStatus",
+ "modelAsString": true
+ }
+ },
+ "rdmaStatus": {
+ "description": "Value indicating whether this adapter is RDMA capable.",
+ "enum": [
+ "Incapable",
+ "Capable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkAdapterRDMAStatus",
+ "modelAsString": true
+ }
+ },
+ "dhcpStatus": {
+ "description": "Value indicating whether this adapter has DHCP enabled.",
+ "enum": [
+ "Disabled",
+ "Enabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NetworkAdapterDHCPStatus",
+ "modelAsString": true
+ }
+ },
+ "ipv4Configuration": {
+ "$ref": "#/definitions/Ipv4Config",
+ "description": "The IPv4 configuration of the network adapter.",
+ "readOnly": true
+ },
+ "ipv6Configuration": {
+ "$ref": "#/definitions/Ipv6Config",
+ "description": "The IPv6 configuration of the network adapter.",
+ "readOnly": true
+ },
+ "ipv6LinkLocalAddress": {
+ "description": "The IPv6 local address.",
+ "type": "string",
+ "readOnly": true
+ },
+ "dnsServers": {
+ "description": "The list of DNS Servers of the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "NetworkAdapterPosition": {
+ "description": "The network adapter position.",
+ "type": "object",
+ "properties": {
+ "networkGroup": {
+ "description": "The network group.",
+ "enum": [
+ "None",
+ "NonRDMA",
+ "RDMA"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NetworkGroup",
+ "modelAsString": true
+ }
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "NetworkSettings": {
+ "description": "The network settings of a device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/NetworkSettingsProperties",
+ "description": "The properties of network settings of a device.",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of NetworkSettings",
+ "readOnly": true
+ }
+ }
+ },
+ "NetworkSettingsProperties": {
+ "description": "The properties of network settings.",
+ "type": "object",
+ "properties": {
+ "networkAdapters": {
+ "description": "The network adapter list on the device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkAdapter"
+ },
+ "x-ms-identifiers": [
+ "adapterId"
+ ],
+ "readOnly": true
+ }
+ }
+ },
+ "Node": {
+ "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/NodeProperties",
+ "description": "The properties of the node",
+ "readOnly": true,
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "NodeInfo": {
+ "description": "Kubernetes node info",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Node name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Node type - Master/Worker",
+ "enum": [
+ "Invalid",
+ "Master",
+ "Worker",
+ "ManagementCluster",
+ "ControlPlane",
+ "NodePool"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesNodeType",
+ "modelAsString": true
+ }
+ },
+ "ipConfiguration": {
+ "description": "IP Configuration of the Kubernetes node.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/KubernetesIPConfiguration"
+ },
+ "x-ms-identifiers": [
+ "ipAddress",
+ "port"
+ ]
+ },
+ "componentType": {
+ "description": "ComponentType of the Kubernetes node.",
+ "enum": [
+ "Invalid",
+ "Cluster",
+ "Node",
+ "Etcd",
+ "CNI",
+ "LoadBalancer"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KubernetesComponentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "NodeList": {
+ "description": "Collection of Nodes.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of Nodes.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Node"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "NodeProperties": {
+ "description": "This class represents the nodes in a highly available cluster",
+ "type": "object",
+ "properties": {
+ "nodeStatus": {
+ "description": "The current status of the individual node",
+ "enum": [
+ "Unknown",
+ "Up",
+ "Down",
+ "Rebooting",
+ "ShuttingDown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "NodeStatus",
+ "modelAsString": true
+ }
+ },
+ "nodeChassisSerialNumber": {
+ "description": "Serial number of the Chassis",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeSerialNumber": {
+ "description": "Serial number of the individual node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeDisplayName": {
+ "description": "Display Name of the individual node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeFriendlySoftwareVersion": {
+ "description": "Friendly software version name that is currently installed on the node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeHcsVersion": {
+ "description": "HCS version that is currently installed on the node",
+ "type": "string",
+ "readOnly": true
+ },
+ "nodeInstanceId": {
+ "description": "Guid instance id of the node",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "NumaNodeData": {
+ "description": "NUMA node data.",
+ "type": "object",
+ "properties": {
+ "numaNodeIndex": {
+ "format": "int32",
+ "description": "The NUMA node index.",
+ "type": "integer"
+ },
+ "totalMemoryInMb": {
+ "format": "int64",
+ "description": "The total memory on the NUMA node.",
+ "type": "integer"
+ },
+ "logicalCoreCountPerCore": {
+ "format": "int32",
+ "description": "The logical cores per core count.",
+ "type": "integer"
+ },
+ "effectiveAvailableMemoryInMb": {
+ "format": "int64",
+ "description": "The effective available memory on the NUMA node in MB.",
+ "type": "integer"
+ },
+ "freeVCpuIndexesForHpn": {
+ "description": "The free VCPU indices for the Hpn VMs.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "vCpuIndexesForHpn": {
+ "description": "The VCPU indices for Hpn VMs",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "vCpuIndexesForRoot": {
+ "description": "The VCPU indices for the root.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ }
+ },
+ "Operation": {
+ "description": "Operations.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Is data action.",
+ "type": "boolean"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay",
+ "description": "Properties displayed for the operation."
+ },
+ "origin": {
+ "description": "Origin of the operation.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationProperties",
+ "description": "Operation properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "Operation display properties.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Provider name.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "The type of resource in which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation to be performed on the resource.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation to be performed.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationProperties": {
+ "description": "Operation properties.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ServiceSpecification",
+ "description": "Service specification."
+ }
+ }
+ },
+ "OperationsList": {
+ "description": "The list of operations used for the discovery of available provider operations.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string"
+ }
+ }
+ },
+ "Order": {
+ "description": "The order details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "It specify the order api version.",
+ "type": "string",
+ "readOnly": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Order",
+ "readOnly": true
+ },
+ "properties": {
+ "$ref": "#/definitions/OrderProperties",
+ "description": "The order properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OrderList": {
+ "description": "List of order entities.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of orders.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Order"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "OrderProperties": {
+ "description": "Order properties.",
+ "type": "object",
+ "required": [
+ "contactInformation"
+ ],
+ "properties": {
+ "orderId": {
+ "description": "It specify the order resource id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "contactInformation": {
+ "$ref": "#/definitions/ContactDetails",
+ "description": "The contact details."
+ },
+ "shippingAddress": {
+ "$ref": "#/definitions/Address",
+ "description": "The shipping address."
+ },
+ "currentStatus": {
+ "$ref": "#/definitions/OrderStatus",
+ "description": "Current status of the order.",
+ "readOnly": true
+ },
+ "orderHistory": {
+ "description": "List of status changes in the order.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OrderStatus"
+ },
+ "x-ms-identifiers": [
+ "trackingInformation/serialNumber"
+ ],
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Serial number of the device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "deliveryTrackingInfo": {
+ "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrackingInfo"
+ },
+ "x-ms-identifiers": [
+ "serialNumber"
+ ],
+ "readOnly": true
+ },
+ "returnTrackingInfo": {
+ "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TrackingInfo"
+ },
+ "x-ms-identifiers": [
+ "serialNumber"
+ ],
+ "readOnly": true
+ },
+ "shipmentType": {
+ "description": "ShipmentType of the order",
+ "enum": [
+ "NotApplicable",
+ "ShippedToCustomer",
+ "SelfPickup"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShipmentType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "OrderStatus": {
+ "description": "Represents a single status change.",
+ "required": [
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Status of the order as per the allowed status types.",
+ "enum": [
+ "Untracked",
+ "AwaitingFulfillment",
+ "AwaitingPreparation",
+ "AwaitingShipment",
+ "Shipped",
+ "Arriving",
+ "Delivered",
+ "ReplacementRequested",
+ "LostDevice",
+ "Declined",
+ "ReturnInitiated",
+ "AwaitingReturnShipment",
+ "ShippedBack",
+ "CollectedAtMicrosoft",
+ "AwaitingPickup",
+ "PickupCompleted",
+ "AwaitingDrop"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OrderState",
+ "modelAsString": true
+ }
+ },
+ "updateDateTime": {
+ "format": "date-time",
+ "description": "Time of status update.",
+ "type": "string",
+ "readOnly": true
+ },
+ "comments": {
+ "description": "Comments related to this status change.",
+ "type": "string"
+ },
+ "trackingInformation": {
+ "$ref": "#/definitions/TrackingInfo",
+ "description": "Tracking information related to the state in the ordering flow",
+ "readOnly": true
+ },
+ "additionalOrderDetails": {
+ "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "PeriodicTimerEventTrigger": {
+ "description": "Trigger details.",
+ "required": [
+ "properties",
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Trigger"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PeriodicTimerProperties",
+ "description": "Periodic timer trigger properties.",
+ "x-ms-client-flatten": true
+ },
+ "id": {
+ "description": "The path ID that uniquely identifies the object.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "The object name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The hierarchical type of the object.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-discriminator-value": "PeriodicTimerEvent"
+ },
+ "PeriodicTimerProperties": {
+ "description": "Periodic timer trigger properties.",
+ "required": [
+ "sourceInfo",
+ "sinkInfo"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceInfo": {
+ "$ref": "#/definitions/PeriodicTimerSourceInfo",
+ "description": "Periodic timer details."
+ },
+ "sinkInfo": {
+ "$ref": "#/definitions/RoleSinkInfo",
+ "description": "Role Sink information."
+ },
+ "customContextTag": {
+ "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
+ "maxLength": 192,
+ "type": "string"
+ }
+ }
+ },
+ "PeriodicTimerSourceInfo": {
+ "description": "Periodic timer event source.",
+ "required": [
+ "startTime",
+ "schedule"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "Topic where periodic events are published to IoT device.",
+ "type": "string"
+ }
+ }
+ },
+ "ProactiveLogCollectionSettingsProperties": {
+ "description": "The properties of proactive log collection settings.",
+ "required": [
+ "userConsent"
+ ],
+ "type": "object",
+ "properties": {
+ "userConsent": {
+ "description": "Proactive diagnostic collection consent flag",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProactiveDiagnosticsConsent",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "RawCertificateData": {
+ "description": "Raw Certificate Data.",
+ "required": [
+ "certificate"
+ ],
+ "type": "object",
+ "properties": {
+ "authenticationType": {
+ "description": "The authentication type.",
+ "enum": [
+ "Invalid",
+ "AzureActiveDirectory"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AuthenticationType",
+ "modelAsString": true
+ }
+ },
+ "certificate": {
+ "description": "The base64 encoded certificate raw data.",
+ "type": "string"
+ }
+ }
+ },
+ "RefreshDetails": {
+ "description": "Fields for tracking refresh job on the share or container.",
+ "type": "object",
+ "properties": {
+ "inProgressRefreshJobId": {
+ "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.",
+ "type": "string"
+ },
+ "lastCompletedRefreshJobTimeInUTC": {
+ "format": "date-time",
+ "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.",
+ "type": "string"
+ },
+ "errorManifestFile": {
+ "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.",
+ "type": "string"
+ },
+ "lastJob": {
+ "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.",
+ "type": "string"
+ }
+ }
+ },
+ "RemoteSupportSettings": {
+ "description": "RemoteApplicationType for which remote support settings is being modified",
+ "type": "object",
+ "properties": {
+ "remoteApplicationType": {
+ "description": "Remote application type",
+ "enum": [
+ "Powershell",
+ "WAC",
+ "LocalUI",
+ "AllApplications"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RemoteApplicationType",
+ "modelAsString": true
+ }
+ },
+ "accessLevel": {
+ "description": "Access level allowed for this remote application type",
+ "enum": [
+ "None",
+ "ReadOnly",
+ "ReadWrite",
+ "FullAccess"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccessLevel",
+ "modelAsString": true
+ }
+ },
+ "expirationTimeStampInUTC": {
+ "format": "date-time",
+ "description": "Expiration time stamp",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceIdentity": {
+ "description": "Msi identity details of the resource",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Identity type",
+ "enum": [
+ "None",
+ "SystemAssigned",
+ "UserAssigned"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MsiIdentityType",
+ "modelAsString": true
+ }
+ },
+ "principalId": {
+ "description": "Service Principal Id backing the Msi",
+ "type": "string",
+ "readOnly": true
+ },
+ "tenantId": {
+ "description": "Home Tenant Id",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceMoveDetails": {
+ "description": "Fields for tracking resource move",
+ "type": "object",
+ "properties": {
+ "operationInProgress": {
+ "description": "Denotes whether move operation is in progress",
+ "enum": [
+ "None",
+ "ResourceMoveInProgress",
+ "ResourceMoveFailed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceMoveStatus",
+ "modelAsString": true
+ }
+ },
+ "operationInProgressLockTimeoutInUTC": {
+ "format": "date-time",
+ "description": "Denotes the timeout of the operation to finish",
+ "type": "string"
+ }
+ }
+ },
+ "Role": {
+ "description": "Compute role.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Role type.",
+ "enum": [
+ "IOT",
+ "ASA",
+ "Functions",
+ "Cognitive",
+ "MEC",
+ "CloudEdgeManagement",
+ "Kubernetes"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RoleTypes",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Role",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "RoleList": {
+ "description": "Collection of all the roles on the Data Box Edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The Value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Role"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RoleSinkInfo": {
+ "description": "Compute role against which events will be raised.",
+ "required": [
+ "roleId"
+ ],
+ "type": "object",
+ "properties": {
+ "roleId": {
+ "description": "Compute role ID.",
+ "type": "string"
+ }
+ }
+ },
+ "Secret": {
+ "description": "Holds device secret either as a KeyVault reference or as an encrypted value.",
+ "type": "object",
+ "properties": {
+ "encryptedSecret": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Encrypted (using device public key) secret value."
+ },
+ "keyVaultId": {
+ "description": "Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).",
+ "type": "string"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "The security settings of a device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SecuritySettingsProperties",
+ "description": "Properties of the security settings.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SecuritySettingsProperties": {
+ "description": "The properties of security settings.",
+ "required": [
+ "deviceAdminPassword"
+ ],
+ "type": "object",
+ "properties": {
+ "deviceAdminPassword": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters."
+ }
+ }
+ },
+ "ServiceSpecification": {
+ "description": "Service specification.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "description": "Metric specification as defined by shoebox.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricSpecification_V1"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "Share": {
+ "description": "Represents a share on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ShareProperties",
+ "description": "The share properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Share",
+ "readOnly": true
+ }
+ }
+ },
+ "ShareAccessRight": {
+ "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.",
+ "required": [
+ "shareId",
+ "accessType"
+ ],
+ "type": "object",
+ "properties": {
+ "shareId": {
+ "description": "The share ID.",
+ "type": "string"
+ },
+ "accessType": {
+ "description": "Type of access to be allowed on the share for this user.",
+ "enum": [
+ "Change",
+ "Read",
+ "Custom"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ShareList": {
+ "description": "Collection of all the shares on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of shares.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Share"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ShareProperties": {
+ "description": "The share properties.",
+ "required": [
+ "shareStatus",
+ "monitoringStatus",
+ "accessProtocol"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description for the share.",
+ "type": "string"
+ },
+ "shareStatus": {
+ "description": "Current status of the share.",
+ "enum": [
+ "Offline",
+ "Unknown",
+ "OK",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareStatus",
+ "modelAsString": true
+ }
+ },
+ "monitoringStatus": {
+ "description": "Current monitoring status of the share.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MonitoringStatus",
+ "modelAsString": true
+ }
+ },
+ "azureContainerInfo": {
+ "$ref": "#/definitions/AzureContainerInfo",
+ "description": "Azure container mapping for the share."
+ },
+ "accessProtocol": {
+ "description": "Access protocol to be used by the share.",
+ "enum": [
+ "SMB",
+ "NFS"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessProtocol",
+ "modelAsString": true
+ }
+ },
+ "userAccessRights": {
+ "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UserAccessRight"
+ },
+ "x-ms-identifiers": [
+ "userId"
+ ]
+ },
+ "clientAccessRights": {
+ "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ClientAccessRight"
+ },
+ "x-ms-identifiers": [
+ "client"
+ ]
+ },
+ "refreshDetails": {
+ "$ref": "#/definitions/RefreshDetails",
+ "description": "Details of the refresh job on this share."
+ },
+ "shareMappings": {
+ "description": "Share mount point to the role.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MountPointMap"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ],
+ "readOnly": true
+ },
+ "dataPolicy": {
+ "description": "Data policy of the share.",
+ "enum": [
+ "Cloud",
+ "Local"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataPolicy",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "Sku": {
+ "description": "The SKU type.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "SKU name.",
+ "enum": [
+ "Gateway",
+ "Edge",
+ "TEA_1Node",
+ "TEA_1Node_UPS",
+ "TEA_1Node_Heater",
+ "TEA_1Node_UPS_Heater",
+ "TEA_4Node_Heater",
+ "TEA_4Node_UPS_Heater",
+ "TMA",
+ "TDC",
+ "TCA_Small",
+ "GPU",
+ "TCA_Large",
+ "EdgeP_Base",
+ "EdgeP_High",
+ "EdgePR_Base",
+ "EdgePR_Base_UPS",
+ "EP2_64_1VPU_W",
+ "EP2_128_1T4_Mx1_W",
+ "EP2_256_2T4_W",
+ "EdgeMR_Mini",
+ "RCA_Small",
+ "RCA_Large",
+ "RDC",
+ "Management",
+ "EP2_64_Mx1_W",
+ "EP2_128_GPU1_Mx1_W",
+ "EP2_256_GPU2_Mx1",
+ "EdgeMR_TCP"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ "tier": {
+ "description": "The SKU tier. This is based on the SKU name.",
+ "enum": [
+ "Standard"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SkuTier",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "SkuCapability": {
+ "description": "The metadata to describe the capability.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "An invariant to describe the feature.",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "An invariant if the feature is measured by quantity.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuCost": {
+ "description": "The metadata for retrieving price info.",
+ "type": "object",
+ "properties": {
+ "meterId": {
+ "description": "Used for querying price from commerce.",
+ "type": "string",
+ "readOnly": true
+ },
+ "quantity": {
+ "format": "int64",
+ "description": "The cost quantity.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "extendedUnit": {
+ "description": "The extended unit.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuLocationInfo": {
+ "description": "The location info.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "zones": {
+ "description": "The zones.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "sites": {
+ "description": "The sites.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "SkuMapping": {
+ "type": "object",
+ "properties": {
+ "catalogPlanId": {
+ "type": "string"
+ },
+ "marketplaceSkuId": {
+ "type": "string"
+ },
+ "marketplaceSkuVersions": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "StorageAccount": {
+ "description": "Represents a Storage Account on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageAccountProperties",
+ "description": "The Storage Account properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of StorageAccount",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredential": {
+ "description": "The storage account credential.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StorageAccountCredentialProperties",
+ "description": "The storage account credential properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of StorageAccountCredential",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredentialList": {
+ "description": "The collection of storage account credentials.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StorageAccountCredential"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountCredentialProperties": {
+ "description": "The storage account credential properties.",
+ "required": [
+ "alias",
+ "sslStatus",
+ "accountType"
+ ],
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias for the storage account.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Username for the storage account.",
+ "type": "string"
+ },
+ "accountKey": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Encrypted storage key."
+ },
+ "connectionString": {
+ "description": "Connection string for the storage account. Use this string if username and account key are not specified.",
+ "type": "string"
+ },
+ "sslStatus": {
+ "description": "Signifies whether SSL needs to be enabled or not.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SSLStatus",
+ "modelAsString": true
+ }
+ },
+ "blobDomainName": {
+ "description": "Blob end point for private clouds.",
+ "type": "string"
+ },
+ "accountType": {
+ "description": "Type of storage accessed on the storage account.",
+ "enum": [
+ "GeneralPurposeStorage",
+ "BlobStorage"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccountType",
+ "modelAsString": true
+ }
+ },
+ "storageAccountId": {
+ "description": "Id of the storage account.",
+ "type": "string"
+ }
+ }
+ },
+ "StorageAccountList": {
+ "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of storageAccounts.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StorageAccount"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StorageAccountProperties": {
+ "description": "The storage account properties.",
+ "required": [
+ "dataPolicy"
+ ],
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description for the storage Account.",
+ "type": "string"
+ },
+ "storageAccountStatus": {
+ "description": "Current status of the storage account",
+ "enum": [
+ "OK",
+ "Offline",
+ "Unknown",
+ "Updating",
+ "NeedsAttention"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "StorageAccountStatus",
+ "modelAsString": true
+ }
+ },
+ "dataPolicy": {
+ "description": "Data policy of the storage Account.",
+ "enum": [
+ "Cloud",
+ "Local"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataPolicy",
+ "modelAsString": true
+ }
+ },
+ "storageAccountCredentialId": {
+ "description": "Storage Account Credential Id",
+ "type": "string"
+ },
+ "blobEndpoint": {
+ "description": "BlobEndpoint of Storage Account",
+ "type": "string",
+ "readOnly": true
+ },
+ "containerCount": {
+ "format": "int32",
+ "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "SubscriptionProperties": {
+ "type": "object",
+ "properties": {
+ "tenantId": {
+ "type": "string"
+ },
+ "locationPlacementId": {
+ "type": "string"
+ },
+ "quotaId": {
+ "type": "string"
+ },
+ "serializedDetails": {
+ "type": "string"
+ },
+ "registeredFeatures": {
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SubscriptionRegisteredFeatures"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ]
+ }
+ }
+ },
+ "SubscriptionRegisteredFeatures": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ }
+ }
+ },
+ "SupportPackageRequestProperties": {
+ "description": "The share properties.",
+ "type": "object",
+ "properties": {
+ "minimumTimeStamp": {
+ "format": "date-time",
+ "description": "MinimumTimeStamp from where logs need to be collected",
+ "type": "string"
+ },
+ "maximumTimeStamp": {
+ "format": "date-time",
+ "description": "Start of the timespan of the log collection",
+ "type": "string"
+ },
+ "include": {
+ "description": "Type of files, which need to be included in the logs\r\nThis will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)\r\nor a comma separated list of log types that are required",
+ "type": "string"
+ }
+ }
+ },
+ "SymmetricKey": {
+ "description": "Symmetric key for authentication.",
+ "type": "object",
+ "properties": {
+ "connectionString": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "Connection string based on the symmetric key."
+ }
+ }
+ },
+ "TrackingInfo": {
+ "description": "Tracking courier information.",
+ "type": "object",
+ "properties": {
+ "serialNumber": {
+ "description": "Serial number of the device being tracked.",
+ "type": "string"
+ },
+ "carrierName": {
+ "description": "Name of the carrier used in the delivery.",
+ "type": "string"
+ },
+ "trackingId": {
+ "description": "Tracking ID of the shipment.",
+ "type": "string"
+ },
+ "trackingUrl": {
+ "description": "Tracking URL of the shipment.",
+ "type": "string"
+ }
+ }
+ },
+ "Trigger": {
+ "description": "Trigger details.",
+ "required": [
+ "kind"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "kind": {
+ "description": "Trigger Kind.",
+ "enum": [
+ "FileEvent",
+ "PeriodicTimerEvent"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TriggerEventType",
+ "modelAsString": true
+ }
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of Trigger",
+ "readOnly": true
+ }
+ },
+ "discriminator": "kind"
+ },
+ "TriggerList": {
+ "description": "Collection of all trigger on the data box edge device.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of triggers.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Trigger"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TriggerSupportPackageRequest": {
+ "description": "The request object for trigger support package.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SupportPackageRequestProperties",
+ "description": "The TriggerSupportPackageRequest properties.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UpdateDetails": {
+ "description": "Update Specific attributes",
+ "type": "object",
+ "properties": {
+ "updateTitle": {
+ "description": "Title of the Update",
+ "type": "string"
+ },
+ "updateSize": {
+ "format": "double",
+ "description": "Size of the update(In Bytes)",
+ "type": "number"
+ },
+ "updateType": {
+ "description": "Type of the Update",
+ "enum": [
+ "Software",
+ "Kubernetes",
+ "Firmware"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UpdateType",
+ "modelAsString": true
+ }
+ },
+ "targetVersion": {
+ "description": "Target Version number",
+ "type": "string"
+ },
+ "friendlyVersionNumber": {
+ "description": "Friendly Version Number",
+ "type": "string"
+ },
+ "estimatedInstallTimeInMins": {
+ "format": "int32",
+ "description": "Estimated Install Time for the update",
+ "type": "integer"
+ },
+ "rebootBehavior": {
+ "description": "Indicates if updates are available and at least one of the updates needs a reboot.",
+ "enum": [
+ "NeverReboots",
+ "RequiresReboot",
+ "RequestReboot"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InstallRebootBehavior",
+ "modelAsString": true
+ }
+ },
+ "installationImpact": {
+ "description": "Impact of Installing an updateType",
+ "enum": [
+ "None",
+ "DeviceRebooted",
+ "KubernetesWorkloadsDown"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InstallationImpact",
+ "modelAsString": true
+ }
+ },
+ "status": {
+ "description": "Status of the update.",
+ "enum": [
+ "DownloadPending",
+ "DownloadStarted",
+ "DownloadCompleted",
+ "InstallStarted",
+ "InstallCompleted"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UpdateStatus",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UpdateDownloadProgress": {
+ "description": "Details about the download progress of update.",
+ "type": "object",
+ "properties": {
+ "downloadPhase": {
+ "description": "The download phase.",
+ "enum": [
+ "Unknown",
+ "Initializing",
+ "Downloading",
+ "Verifying"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DownloadPhase",
+ "modelAsString": true
+ }
+ },
+ "percentComplete": {
+ "format": "int32",
+ "description": "Percentage of completion.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalBytesToDownload": {
+ "format": "double",
+ "description": "Total bytes to download.",
+ "type": "number",
+ "readOnly": true
+ },
+ "totalBytesDownloaded": {
+ "format": "double",
+ "description": "Total bytes downloaded.",
+ "type": "number",
+ "readOnly": true
+ },
+ "numberOfUpdatesToDownload": {
+ "format": "int32",
+ "description": "Number of updates to download.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesDownloaded": {
+ "format": "int32",
+ "description": "Number of updates downloaded.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateInstallProgress": {
+ "description": "Progress details during installation of updates.",
+ "type": "object",
+ "properties": {
+ "percentComplete": {
+ "format": "int32",
+ "description": "Percentage completed.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesToInstall": {
+ "format": "int32",
+ "description": "Number of updates to install.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "numberOfUpdatesInstalled": {
+ "format": "int32",
+ "description": "Number of updates installed.",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateSummary": {
+ "description": "Details about ongoing updates and availability of updates on the device.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UpdateSummaryProperties",
+ "description": "The device update information summary.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of UpdateSummary",
+ "readOnly": true
+ }
+ }
+ },
+ "UpdateSummaryProperties": {
+ "description": "The device update information summary.",
+ "type": "object",
+ "properties": {
+ "deviceVersionNumber": {
+ "description": "The current version of the device in format: 1.2.17312.13.\",",
+ "type": "string"
+ },
+ "friendlyDeviceVersionName": {
+ "description": "The current version of the device in text format.",
+ "type": "string"
+ },
+ "deviceLastScannedDateTime": {
+ "format": "date-time",
+ "description": "The last time when a scan was done on the device.",
+ "type": "string"
+ },
+ "lastCompletedScanJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string"
+ },
+ "lastSuccessfulScanJobTime": {
+ "format": "date-time",
+ "description": "Time when the last scan job is successfully completed.",
+ "type": "string"
+ },
+ "lastCompletedDownloadJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCompletedDownloadJobId": {
+ "description": "JobId of the last ran download job.(Can be success/cancelled/failed)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastDownloadJobStatus": {
+ "description": "JobStatus of the last ran download job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "lastSuccessfulInstallJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the Last Install job was completed successfully on the appliance",
+ "type": "string"
+ },
+ "lastCompletedInstallJobDateTime": {
+ "format": "date-time",
+ "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCompletedInstallJobId": {
+ "description": "JobId of the last ran install job.(Can be success/cancelled/failed)",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastInstallJobStatus": {
+ "description": "JobStatus of the last ran install job.",
+ "enum": [
+ "Invalid",
+ "Running",
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "Paused",
+ "Scheduled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "JobStatus",
+ "modelAsString": true
+ }
+ },
+ "totalNumberOfUpdatesAvailable": {
+ "format": "int32",
+ "description": "The number of updates available for the current device version as per the last device scan.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalNumberOfUpdatesPendingDownload": {
+ "format": "int32",
+ "description": "The total number of items pending download.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "totalNumberOfUpdatesPendingInstall": {
+ "format": "int32",
+ "description": "The total number of items pending install.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "rebootBehavior": {
+ "description": "Indicates if updates are available and at least one of the updates needs a reboot.",
+ "enum": [
+ "NeverReboots",
+ "RequiresReboot",
+ "RequestReboot"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "InstallRebootBehavior",
+ "modelAsString": true
+ }
+ },
+ "ongoingUpdateOperation": {
+ "description": "The current update operation.",
+ "enum": [
+ "None",
+ "Scan",
+ "Download",
+ "Install"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "UpdateOperation",
+ "modelAsString": true
+ }
+ },
+ "inProgressDownloadJobId": {
+ "description": "The job ID of the download job in progress.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressInstallJobId": {
+ "description": "The job ID of the install job in progress.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressDownloadJobStartedDateTime": {
+ "format": "date-time",
+ "description": "The time when the currently running download (if any) started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inProgressInstallJobStartedDateTime": {
+ "format": "date-time",
+ "description": "The time when the currently running install (if any) started.",
+ "type": "string",
+ "readOnly": true
+ },
+ "updateTitles": {
+ "description": "The list of updates available for install.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "updates": {
+ "description": "The list of updates available for install.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/UpdateDetails"
+ },
+ "x-ms-identifiers": [
+ "updateTitle"
+ ],
+ "readOnly": true
+ },
+ "totalUpdateSizeInBytes": {
+ "format": "double",
+ "description": "The total size of updates available for download in bytes.",
+ "type": "number",
+ "readOnly": true
+ },
+ "totalTimeInMinutes": {
+ "format": "int32",
+ "description": "The total time in Minutes",
+ "type": "integer",
+ "readOnly": true
+ }
+ }
+ },
+ "UploadCertificateRequest": {
+ "description": "The upload certificate request.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/RawCertificateData",
+ "description": "The Base 64 encoded certificate raw data.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UploadCertificateResponse": {
+ "description": "The upload registration certificate response.",
+ "type": "object",
+ "properties": {
+ "authType": {
+ "description": "Specifies authentication type.",
+ "enum": [
+ "Invalid",
+ "AzureActiveDirectory"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AuthenticationType",
+ "modelAsString": true
+ }
+ },
+ "resourceId": {
+ "description": "The resource ID of the Data Box Edge/Gateway device.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadAuthority": {
+ "description": "Azure Active Directory tenant authority.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadTenantId": {
+ "description": "Azure Active Directory tenant ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "servicePrincipalClientId": {
+ "description": "Azure Active Directory service principal client ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "servicePrincipalObjectId": {
+ "description": "Azure Active Directory service principal object ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "azureManagementEndpointAudience": {
+ "description": "The azure management endpoint audience.",
+ "type": "string",
+ "readOnly": true
+ },
+ "aadAudience": {
+ "description": "Identifier of the target resource that is the recipient of the requested token.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "User": {
+ "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ARMBaseModel"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/UserProperties",
+ "description": "The storage account credential properties.",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
+ "description": "Metadata pertaining to creation and last modification of User",
+ "readOnly": true
+ }
+ }
+ },
+ "UserAccessRight": {
+ "description": "The mapping between a particular user and the access type on the SMB share.",
+ "required": [
+ "userId",
+ "accessType"
+ ],
+ "type": "object",
+ "properties": {
+ "userId": {
+ "description": "User ID (already existing in the device).",
+ "type": "string"
+ },
+ "accessType": {
+ "description": "Type of access to be allowed for the user.",
+ "enum": [
+ "Change",
+ "Read",
+ "Custom"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ShareAccessType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "UserList": {
+ "description": "Collection of users.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of users.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/User"
+ },
+ "readOnly": true,
+ "x-ms-identifiers": []
+ },
+ "nextLink": {
+ "description": "Link to the next set of results.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "UserProperties": {
+ "description": "The user properties.",
+ "required": [
+ "userType"
+ ],
+ "type": "object",
+ "properties": {
+ "encryptedPassword": {
+ "$ref": "#/definitions/AsymmetricEncryptedSecret",
+ "description": "The password details."
+ },
+ "shareAccessRights": {
+ "description": "List of shares that the user has rights on. This field should not be specified during user creation.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ShareAccessRight"
+ },
+ "x-ms-identifiers": [
+ "shareId"
+ ],
+ "readOnly": true
+ },
+ "userType": {
+ "description": "Type of the user.",
+ "enum": [
+ "Share",
+ "LocalManagement",
+ "ARM"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UserType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "VmMemory": {
+ "description": "VmMemory Data.",
+ "type": "object",
+ "properties": {
+ "startupMemoryMB": {
+ "format": "int64",
+ "description": "The total amount of RAM in the virtual machine, as seen by the guest operating system. For a virtual machine with dynamic memory enabled, this represents the initial memory available at startup.",
+ "type": "integer"
+ },
+ "currentMemoryUsageMB": {
+ "format": "int64",
+ "description": "The current memory used by the virtual machine.",
+ "type": "integer"
+ }
+ }
+ },
+ "VmPlacementRequestResult": {
+ "description": "List of VM sizes being checked for creation on appliance along with corresponding result.",
+ "type": "object",
+ "properties": {
+ "vmSize": {
+ "description": "List of VM sizes being checked.",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isFeasible": {
+ "description": "Boolean value indicating if the VM(s) in VmSize can be created.",
+ "type": "boolean"
+ },
+ "messageCode": {
+ "description": "MessageCode indicating reason for success or failure.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Localized message to be displayed to the user to explain the check result.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The API version.",
+ "required": true,
+ "type": "string"
+ },
+ "locationParameter": {
+ "name": "location",
+ "in": "path",
+ "description": "The location of the resource.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The resource group name.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "securityDefinitions": {
+ "azure_auth": {
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "scopes": {
+ "user_impersonation": "impersonate your user account"
+ },
+ "type": "oauth2",
+ "description": "Azure Active Directory OAuth2 Flow"
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "tags": []
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGet.json
new file mode 100644
index 000000000000..2776f5aedaa9
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGet.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+ "alertType": "UpdateScanFailedEvent",
+ "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+ "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+ "severity": "Critical",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 1
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "type": "dataBoxEdgeDevices/alerts"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGetAllInDevice.json
new file mode 100644
index 000000000000..a23ed4fd3eb4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AlertGetAllInDevice.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "title": "Device password has changed",
+ "alertType": "PasswordChangedEvent",
+ "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z",
+ "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.",
+ "severity": "Informational",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 2
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790",
+ "name": "83eccd0b-134b-40b0-ad62-b5f124d03790",
+ "type": "dataBoxEdgeDevices/alerts"
+ },
+ {
+ "properties": {
+ "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.",
+ "alertType": "UpdateScanFailedEvent",
+ "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z",
+ "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.",
+ "severity": "Critical",
+ "errorDetails": {
+ "errorCode": "",
+ "errorMessage": "",
+ "occurrences": 1
+ },
+ "detailedInformation": {}
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "type": "dataBoxEdgeDevices/alerts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AvailableSkusList.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AvailableSkusList.json
new file mode 100644
index 000000000000..6514d2e8642f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/AvailableSkusList.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "location": "westus",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "dataBoxEdgeDevices",
+ "name": "Gateway",
+ "availability": "Available",
+ "tier": "Standard",
+ "kind": "AzureDataBoxGateway",
+ "version": "Stable",
+ "signupOption": "Available",
+ "locations": [
+ "West US"
+ ],
+ "locationInfo": [
+ {
+ "location": "West US"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleDelete.json
new file mode 100644
index 000000000000..ff255920a770
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleDelete.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGet.json
new file mode 100644
index 000000000000..a710396b3637
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGetAllInDevice.json
new file mode 100644
index 000000000000..7814d900d22f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthScheduleGetAllInDevice.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthSchedulePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthSchedulePut.json
new file mode 100644
index 000000000000..d8a0bbcb99b6
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/BandwidthSchedulePut.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "bandwidth-1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "start": "0:0:0",
+ "stop": "13:59:0",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "start": "00:00:00",
+ "stop": "13:59:00",
+ "rateInMbps": 100,
+ "days": [
+ "Sunday",
+ "Monday"
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
+ "name": "bandwidth-1",
+ "type": "dataBoxEdgeDevices/bandwidthSchedules"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerDelete.json
new file mode 100644
index 000000000000..a414bffdc158
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerGet.json
new file mode 100644
index 000000000000..f400972d5748
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerListAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerListAllInDevice.json
new file mode 100644
index 000000000000..4c347d970b97
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerListAllInDevice.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:14:32.3016929Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ },
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:15:38.0077675Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2",
+ "name": "blobcontainer2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ },
+ {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3",
+ "name": "blobcontainer3",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerPut.json
new file mode 100644
index 000000000000..47fe07c3fb7f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerPut.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "container": {
+ "properties": {
+ "dataFormat": "BlockBlob"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "containerStatus": "OK",
+ "dataFormat": "BlockBlob",
+ "refreshDetails": {},
+ "createdDateTime": "2019-10-20T23:13:27.8545799Z"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1",
+ "name": "blobcontainer-5e155efe",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerRefresh.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerRefresh.json
new file mode 100644
index 000000000000..2c8b0d5a1a21
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ContainerRefresh.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "containerName": "blobcontainer1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1/refresh/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceDelete.json
new file mode 100644
index 000000000000..230c2f33d0d5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceDelete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByName.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByName.json
new file mode 100644
index 000000000000..2dd996508355
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByName.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "Offline",
+ "serialNumber": "1D6QHQ2",
+ "deviceType": "DataBoxEdgeDevice",
+ "friendlyName": "DBE-1D6QHQ2",
+ "deviceModel": "Physical",
+ "deviceSoftwareVersion": "Azure Stack Edge 2009",
+ "deviceLocalCapacity": 8042259,
+ "timeZone": "Pacific Standard Time",
+ "deviceHcsVersion": "2.1.1361.23408",
+ "configuredRoleTypes": [
+ "CloudEdgeManagement"
+ ],
+ "nodeCount": 1,
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ }
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json
new file mode 100644
index 000000000000..98be95defda4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByNameWithDataResidency.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "Offline",
+ "serialNumber": "1D6QHQ2",
+ "deviceType": "DataBoxEdgeDevice",
+ "friendlyName": "DBE-1D6QHQ2",
+ "deviceModel": "Physical",
+ "deviceSoftwareVersion": "Azure Stack Edge 2009",
+ "deviceLocalCapacity": 8042259,
+ "timeZone": "Pacific Standard Time",
+ "deviceHcsVersion": "2.1.1361.23408",
+ "configuredRoleTypes": [
+ "CloudEdgeManagement"
+ ],
+ "nodeCount": 1,
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ },
+ "dataResidency": {
+ "type": "ZoneReplication"
+ },
+ "computeVersionInformation": {
+ "kubernetesVersion": "v1.21.7",
+ "iotEdgeVersion": "0.1.0-beta15",
+ "azureArcVersion": "1.5.3"
+ },
+ "kubernetesPlatform": "AKS"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json
new file mode 100644
index 000000000000..0566301f134e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-09-29T18%3A50%3A31.1203818Z'\"_W/\"datetime'2020-09-29T18%3A50%3A31.1343914Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EdgeTestPassResource",
+ "name": "EdgeTestPassResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "centraluseuap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-18T23%3A31%3A30.3266766Z'\"_W/\"datetime'2020-11-18T23%3A31%3A30.3326804Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "d97a6de5-f5c0-485a-8f5e-b7f705d2dbc4",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/FPGAResource",
+ "name": "FPGAResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "centraluseuap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-18T23%3A31%3A23.1715672Z'\"_W/\"datetime'2020-11-18T23%3A31%3A23.2396152Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "6f2b341b-aded-4ec2-a1bd-d09438d6cc8f",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestVMEdgeResource",
+ "name": "TestVMEdgeResource",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json
new file mode 100644
index 000000000000..cf64086260e4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json
@@ -0,0 +1,74 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A39%3A55.1270082Z'\"_W/\"datetime'2020-11-19T01%3A39%3A55.1320118Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "083df009-06d9-4e3c-ae72-f9249a814334",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/linksub01",
+ "name": "linksub01",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A40%3A05.9246966Z'\"_W/\"datetime'2020-11-19T01%3A40%3A05.9317011Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "8536db30-78d2-4759-95b7-896a66e14c24",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest",
+ "name": "mergeazstest",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ },
+ {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Gateway",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T01%3A40%3A06.496102Z'\"_W/\"datetime'2020-11-19T01%3A40%3A06.503107Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "fc4c1205-35c8-4f35-abc7-f5a78945f676",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureDataBoxGateway",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/abhudeda-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/mergeazstest2",
+ "name": "mergeazstest2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePatch.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePatch.json
new file mode 100644
index 000000000000..b6707637c3e0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePatch.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "edgeProfile": {
+ "subscription": {
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/rapvs-rg/providers/Microsoft.AzureStack/linkedSubscriptions/ca014ddc-5cf2-45f8-b390-e901e4a0ae87"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus2euap",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "etag": "W/\"datetime'2020-11-19T04%3A43%3A38.6457308Z'\"_W/\"datetime'2020-11-19T04%3A43%3A38.6507339Z'\"",
+ "identity": {
+ "type": "SystemAssigned",
+ "principalId": "b3e34fcc-ab02-4ca4-9d22-5de115419091",
+ "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
+ },
+ "kind": "AzureStackEdge",
+ "properties": {
+ "dataBoxEdgeDeviceStatus": "ReadyToSetup",
+ "deviceType": "DataBoxEdgeDevice",
+ "deviceLocalCapacity": 0,
+ "timeZone": "Pacific Standard Time",
+ "nodeCount": 0,
+ "resourceMoveDetails": {
+ "operationInProgress": "None"
+ },
+ "edgeProfile": {
+ "subscription": {
+ "registrationId": "91d8753b-af42-4908-9a5e-2a61f08b20de",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/VmMgmtTestPass/providers/Microsoft.AzureStack/edgeSubscriptions/daaac4b0-35c4-4008-bdc6-b72ca5890f16",
+ "state": "Registered"
+ }
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/VmMgmtTestPass/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice",
+ "name": "testedgedevice",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePut.json
new file mode 100644
index 000000000000..6b8b9be9452b
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePut.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "dataBoxEdgeDevice": {
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "name": "testedgedevice"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json
new file mode 100644
index 000000000000..bfa048838c66
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DataBoxEdgeDevicePutWithDataResidency.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "dataBoxEdgeDevice": {
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "properties": {
+ "dataResidency": {
+ "type": "ZoneReplication"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "location": "WUS",
+ "tags": {},
+ "sku": {
+ "name": "Edge",
+ "tier": "Standard"
+ },
+ "name": "testedgedevice",
+ "properties": {
+ "dataResidency": {
+ "type": "ZoneReplication"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteAddons.json
new file mode 100644
index 000000000000..4d51b40f9e5f
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteAddons.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/KubernetesRole/addons/arcName/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteMonitoringConfig.json
new file mode 100644
index 000000000000..03348f55ba0e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeleteMonitoringConfig.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/testrole/monitoringConfig/default/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityGet.json
new file mode 100644
index 000000000000..fdc1bd679684
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityGet.json
@@ -0,0 +1,157 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "timeStamp": "2022-02-28T19:35:34.5585067Z",
+ "clusterStorageCapacityInfo": {
+ "clusterTotalStorageMb": 5368642.0,
+ "clusterFreeStorageMb": 5284151.0
+ },
+ "clusterComputeCapacityInfo": {
+ "fqdn": "3V78B03CL",
+ "gpuCapacity": {
+ "gpuType": "NvidiaTeslaT4",
+ "gpuUsedUnitsCount": 0,
+ "gpuFreeUnitsCount": 1,
+ "gpuReservedForFailoverUnitsCount": 0,
+ "gpuTotalUnitsCount": 1
+ },
+ "memoryCapacity": {
+ "clusterFreeMemoryMb": 20978.64,
+ "clusterUsedMemoryMb": 109711.36,
+ "clusterFailoverMemoryMb": 0.0,
+ "clusterFragmentationMemoryMb": 0.0,
+ "clusterHypervReserveMemoryMb": 19599.36,
+ "clusterInfraVmMemoryMb": 0.0,
+ "clusterTotalMemoryMb": 130690.0,
+ "clusterNonFailoverVmMb": 0.0,
+ "clusterMemoryUsedByVmsMb": 90112.0
+ },
+ "lastRefreshedTime": "2022-02-28T19:35:23.82Z",
+ "totalProvisionedNonHpnCores": 5
+ },
+ "nodeCapacityInfos": {
+ "3V78B03": {
+ "hostName": "3V78B03",
+ "effectiveAvailableMemoryMbOnHost": 45818,
+ "availableGpuCount": 1,
+ "vmUsedMemory": {
+ "2e867196-e44b-49b7-9cb3-46c25973b762": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "23ddd5ea-bda9-467a-803f-1a7e2888d1fa": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 24576
+ },
+ "853efe82-58f1-4f94-8f9c-7752dab6767c": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 24576
+ },
+ "4c4261f0-eac5-4ff6-95ef-2cb70e09d3f6": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "48034ac1-04ce-48e1-89fd-15a6d71fd623": {
+ "startupMemoryMB": 2048,
+ "currentMemoryUsageMB": 2048
+ },
+ "dc3d20b2-8581-41cb-9ca3-1bbc1a8a2fe4": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "c1023a57-d6a0-4a77-9308-48b320bfedbd": {
+ "startupMemoryMB": 3584,
+ "currentMemoryUsageMB": 3584
+ },
+ "6b1817d5-4003-4f17-8423-51c33d9de88c": {
+ "startupMemoryMB": 24576,
+ "currentMemoryUsageMB": 0
+ }
+ },
+ "gpuType": "NvidiaTeslaT4",
+ "numaNodesData": [
+ {
+ "numaNodeIndex": 0,
+ "totalMemoryInMb": 65154,
+ "logicalCoreCountPerCore": 2,
+ "effectiveAvailableMemoryInMb": 30182,
+ "freeVCpuIndexesForHpn": [],
+ "vCpuIndexesForHpn": [],
+ "vCpuIndexesForRoot": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8,
+ 9,
+ 10,
+ 11,
+ 12,
+ 13,
+ 14,
+ 15,
+ 16,
+ 17,
+ 18,
+ 19
+ ]
+ },
+ {
+ "numaNodeIndex": 1,
+ "totalMemoryInMb": 65536,
+ "logicalCoreCountPerCore": 2,
+ "effectiveAvailableMemoryInMb": 19493,
+ "freeVCpuIndexesForHpn": [],
+ "vCpuIndexesForHpn": [],
+ "vCpuIndexesForRoot": [
+ 20,
+ 21,
+ 22,
+ 23,
+ 24,
+ 25,
+ 26,
+ 27,
+ 28,
+ 29,
+ 30,
+ 31,
+ 32,
+ 33,
+ 34,
+ 35,
+ 36,
+ 37,
+ 38,
+ 39
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityInfo/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/deviceCapacityInfo"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityRequestPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityRequestPost.json
new file mode 100644
index 000000000000..047d905583f3
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DeviceCapacityRequestPost.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "deviceCapacityRequestInfo": {
+ "properties": {
+ "vmPlacementQuery": [
+ [
+ "Standard_D2_v2"
+ ]
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/deviceCapacityCheck/Standard_D2_v2/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DownloadUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DownloadUpdatesPost.json
new file mode 100644
index 000000000000..899b427a8490
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/DownloadUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/downloadUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ExtendedInfoPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ExtendedInfoPost.json
new file mode 100644
index 000000000000..d0efcc4ddc2e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ExtendedInfoPost.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "resourceKey": "3482840729935603111",
+ "encryptionKeyThumbprint": "",
+ "encryptionKey": ""
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice",
+ "name": "testedgedevice",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GenerateCertificate.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GenerateCertificate.json
new file mode 100644
index 000000000000..98aae240d122
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GenerateCertificate.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "publicKey": "MIIEDjCCAnagAwIBAgIQEW4wrxj9+JdA4kFLDgegTTANBgkqhkiG9w0BAQUFADBDMUEwPwYDVQQDHjgAQwBCAF8AUABvAHIAdABhAGwAXwA2ADMANwA0ADEAMwA1ADkAMQA4ADAAMAA3ADAAOQAxADcANTAeFw0yMDExMTkwNDU2MjBaFw0yMDExMjIwNTA2MjBaMEMxQTA/BgNVBAMeOABDAEIAXwBQAG8AcgB0AGEAbABfADYAMwA3ADQAMQAzADUAOQAxADgAMAAwADcAMAA5ADEANwA1MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAqG617KAUc4gOoht527o6FGE/c97W/wZIXqKbx4G8vifljXWw3NGDDuSQfidE3MqSMMJ/AAlDhBH/Deo/PAgUWuWB2WgM+KFWrDS0oDBvLVeIIeiMx4LOsbz4J8IbcKrGWf+ulQyum7dE/yBLzPXcPTjhJP0oMfhGOMlVVWbiKaP78/WZk2PmBQaVv7PxAQnJAPqETH2qAyuc9bd0TaMlIER56WhX9+nzsoI0u7RmBEs8+BaudVroiiK/GpEczy73TCRlpVXGChdBHg+NvYRYz91ltCV9Ijo1bdvcUjdgDJZ4Tz7G8XVCQmxbd9ml6OBLgxQUpd9HSGTcIfFiv+rTUwHR7YkY+1UGHsDPOYnBVDTXs3RFm+c5uNnCKvtyTExDJgabT+FTNb3eyD/BSYsy6b/YZBRqPiO8BRFUsIhWhXtPaUjWOEx6XMeZRnGeF4Hi8iH8TR79kEJhfYy3piSPAc3JrhgoglpyyfZOgyPOje+8tAWS9FHUNyVXKKeksDoZAgMBAAEwDQYJKoZIhvcNAQEFBQADggGBACpfQt34mgr+WlFtY0tqaPAoF6XnVzyKB6XsVAoj1uKFTSCQnr0mWvUMWKSRFTu1bV1VdDokV5I+h92kBcO4ddtHhWtkt16j9XFDsGdDvoUWJeqecZVr9fBPC69wF/9R/2E6iJporR46Pui7gcilYGqb3IjJlh8RT/XBPamQrfDbS7G8eTe91ST5cHr89R6EtDwfyhyTZr2sRrvQrxY2AjEmdH5Zcl9q2Xf8DholZhZ9vwnuYBFfl6VCXWaDAzQWiPdxo1wgXxEpNNDstGFWJKnsnz9UCohNAiPf47B+csPqxjcTLVMhcGLdU/lwpzzkEOciijpYILscvPoU3IM6DmFROgU2z6CForpgwHPDJktyWU1MC7lFdfrSzwu/5b3ZAEQhnJf7rvrybULoYBQWJEuj26Is1S6kXpNUaHAc5HIyIoc2V2eRjasbPIqsU0smjPLS/1egjHxtw9u+v4qDDvDuOjhFJtC3NkPl06TfNgO9+5LgiB1JppXnkLyCQ9RQgw==",
+ "privateKey": null,
+ "expiryTimeInUTC": "2020-11-22T05:06:20.000Z"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetAddons.json
new file mode 100644
index 000000000000..7972db09eb57
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetAddons.json
@@ -0,0 +1,42 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDCAccessCode.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDCAccessCode.json
new file mode 100644
index 000000000000..8be8a9e7e2b0
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDCAccessCode.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "authCode": "_sv7-NY2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json
new file mode 100644
index 000000000000..49711a9eaaaa
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticProactiveLogCollectionSettings.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "diagnosticProactiveLogCollectionSettings": {
+ "properties": {
+ "userConsent": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userConsent": "Enabled"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticProactiveLogCollectionSettings/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticRemoteSupportSettings.json
new file mode 100644
index 000000000000..d48f10c6845c
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetDiagnosticRemoteSupportSettings.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00",
+ "remoteApplicationType": "LocalUI"
+ }
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/diagnosticRemoteSupportSettings/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetMonitoringConfig.json
new file mode 100644
index 000000000000..c17fe48d9e51
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetMonitoringConfig.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetParticularImage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetParticularImage.json
new file mode 100644
index 000000000000..b8a72402f709
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetParticularImage.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "versionName": "20348.707.220505",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220505",
+ "name": "20348.707.220505",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetSASToken.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetSASToken.json
new file mode 100644
index 000000000000..8828cc5b4f17
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetSASToken.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "versionName": "20348.707.220505",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "sasUri": "https://m-hd-gz1x3bgv4k.z14.net/zbxp2qfw03/abcd?sv=2018-03-2sr=b&si=15d4c566-3d04-4805-a1a-0ecbf110d2&sig%2FsJoKaU%3D"
+ }
+ },
+ "202": {
+ "body": {
+ "status": "InProgress"
+ },
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition/versions/20348.1006.220908/generatesastoken/operationResults/f7bbd5f3-d6e5-4ad5-a0f8-e49877a08f23?api-version=2022-03-01"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetUpdateExtendedInfo.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetUpdateExtendedInfo.json
new file mode 100644
index 000000000000..6406fdadcef2
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/GetUpdateExtendedInfo.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "parameters": {},
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "clientSecretStoreId": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523",
+ "clientSecretStoreUrl": "https://test-keyvault-ccy-523.vault.azure.net",
+ "channelIntegrityKeyName": "ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59",
+ "channelIntegrityKeyVersion": "95e9b619e65f433d82c9e1ead48214b9",
+ "keyVaultSyncStatus": "KeyVaultSynced",
+ "deviceSecrets": {
+ "HcsDataVolumeBitLockerExternalKey": {
+ "keyVaultId": "Id"
+ },
+ "HcsInternalVolumeBitLockerExternalKey": {
+ "keyVaultId": "Id"
+ },
+ "SystemVolumeBitLockerRecoveryKey": {
+ "keyVaultId": "Id"
+ },
+ "SEDEncryptionExternalKeyId": {},
+ "SEDEncryptionExternalKey": {},
+ "BMCDefaultUserPassword": {},
+ "RotateKeyForDataVolumeBitlocker": {},
+ "RotateKeysForSedDrivesSerialized": {}
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/InstallUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/InstallUpdatesPost.json
new file mode 100644
index 000000000000..a336c3387e8a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/InstallUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/installUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/JobsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/JobsGet.json
new file mode 100644
index 000000000000..498924fb2989
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/JobsGet.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "status": "Succeeded",
+ "startTime": "2018-12-18T02:18:51.4270267Z",
+ "endTime": "2018-12-18T03:18:51.4270267Z",
+ "percentComplete": 100,
+ "properties": {
+ "jobType": "DownloadUpdates",
+ "currentStage": "Success"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListMonitoringConfig.json
new file mode 100644
index 000000000000..8ed8e9a556c5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListMonitoringConfig.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffers.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffers.json
new file mode 100644
index 000000000000..a86975c1b149
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffers.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver",
+ "name": "windowsserver",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ },
+ {
+ "properties": {
+ "publisherId": "tidalmediainc",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc/offers/ubuntu-20-04",
+ "name": "ubuntu-20-04",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ },
+ {
+ "properties": {
+ "publisherId": "tidalmediainc",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc/offers/ubuntu-18-04",
+ "name": "ubuntu-18-04",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffersbyPublisher.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffersbyPublisher.json
new file mode 100644
index 000000000000..b756fe6bed9a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListOffersbyPublisher.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver",
+ "name": "windowsserver",
+ "type": "dataBoxEdgeDevices/publishers/offers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListPublishers.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListPublishers.json
new file mode 100644
index 000000000000..aa2a37488aed
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListPublishers.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver",
+ "name": "microsoftwindowsserver",
+ "type": "dataBoxEdgeDevices/publishers"
+ },
+ {
+ "properties": {
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/tidalmediainc",
+ "name": "tidalmediainc",
+ "type": "dataBoxEdgeDevices/publishers"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListSKUsWithinOffer.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListSKUsWithinOffer.json
new file mode 100644
index 000000000000..124d2426cc76
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListSKUsWithinOffer.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition",
+ "name": "2022-datacenter-azure-edition",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core",
+ "name": "2022-datacenter-azure-edition-core",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2019-datacenter",
+ "name": "2019-datacenter",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2019-datacenter-gensecond",
+ "name": "2019-datacenter-gensecond",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListVersionswithinSKU.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListVersionswithinSKU.json
new file mode 100644
index 000000000000..31cc7b9ff354
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ListVersionswithinSKU.json
@@ -0,0 +1,154 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "eusbvt-pod01-edg1",
+ "deviceName": "eusbvt-masking",
+ "publisherName": "microsoftwindowsserver",
+ "offerName": "windowsserver",
+ "skuName": "2022-datacenter-azure-edition-core",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.887.220907",
+ "name": "20348.887.220907",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.887.220806",
+ "name": "20348.887.220806",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.825.220705",
+ "name": "20348.825.220705",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220609",
+ "name": "20348.707.220609",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.707.220505",
+ "name": "20348.707.220505",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.643.220404",
+ "name": "20348.643.220404",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220304",
+ "name": "20348.469.220304",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220203",
+ "name": "20348.469.220203",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.469.220106",
+ "name": "20348.469.220106",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.288.2112080143",
+ "name": "20348.288.2112080143",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.288.2111011613",
+ "name": "20348.288.2111011613",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ },
+ {
+ "properties": {
+ "publisherId": "microsoftwindowsserver",
+ "offerId": "windowsserver",
+ "skuId": "2022-datacenter-azure-edition-core",
+ "provisioningState": "Succeeded"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/eusbvt-pod01-edg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/eusbvt-masking/publishers/microsoftwindowsserver/offers/windowsserver/skus/2022-datacenter-azure-edition-core/versions/20348.112.2110151130",
+ "name": "20348.112.2110151130",
+ "type": "dataBoxEdgeDevices/publishers/offers/skus/versions"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NetworkSettingsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NetworkSettingsGet.json
new file mode 100644
index 000000000000..ba9f29555a1c
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NetworkSettingsGet.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "networkAdapters": [
+ {
+ "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}",
+ "adapterPosition": {
+ "networkGroup": "NonRDMA",
+ "port": 0
+ },
+ "index": 1,
+ "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984",
+ "networkAdapterName": "DATA1",
+ "label": "DATA1",
+ "macAddress": "00155D4E265B",
+ "linkSpeed": 10000000000,
+ "status": "Inactive",
+ "rdmaStatus": "Incapable",
+ "dhcpStatus": "Disabled",
+ "ipv4Configuration": {
+ "ipAddress": "10.150.78.56",
+ "subnet": "255.255.252.0",
+ "gateway": "10.150.76.1"
+ },
+ "ipv6Configuration": {
+ "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf",
+ "prefixLength": 64,
+ "gateway": "fe80::12f3:11ff:fe36:994b%5"
+ },
+ "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5",
+ "dnsServers": [
+ "10.50.50.50",
+ "10.50.10.50"
+ ]
+ }
+ ]
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NodeGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NodeGetAllInDevice.json
new file mode 100644
index 000000000000..7e908227f3e6
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/NodeGetAllInDevice.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "nodeStatus": "Unknown",
+ "nodeChassisSerialNumber": "1D6QHQ2",
+ "nodeSerialNumber": "1D6QHQ2",
+ "nodeDisplayName": "Controller 1",
+ "nodeFriendlySoftwareVersion": "Data Box Edge 1908",
+ "nodeHcsVersion": "1.6.961.8307",
+ "nodeInstanceId": "ad051874-7d27-4ac4-a7b1-b6f231d8a035"
+ },
+ "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2",
+ "name": "1D6QHQ2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"
+ },
+ {
+ "properties": {
+ "nodeStatus": "Unknown",
+ "nodeChassisSerialNumber": "1D6QHQ2",
+ "nodeSerialNumber": "1DCNHQ2",
+ "nodeDisplayName": "Controller 1",
+ "nodeFriendlySoftwareVersion": "Data Box Edge 1908",
+ "nodeHcsVersion": "1.6.961.8307",
+ "nodeInstanceId": "ddf3a76d-ada4-44af-99c6-a69a0e21bcb6"
+ },
+ "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2",
+ "name": "1DCNHQ2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsGet.json
new file mode 100644
index 000000000000..42a0c2008aeb
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsGet.json
@@ -0,0 +1,675 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "List share users",
+ "description": "Lists or gets the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "List share users",
+ "description": "Lists or gets the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "Creates or updates share users",
+ "description": "Creates or updates the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "share users",
+ "operation": "Delete share users",
+ "description": "Deletes the share users"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "List bandwidth schedules",
+ "description": "Lists or gets the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "List bandwidth schedules",
+ "description": "Lists or gets the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "Creates or updates bandwidth schedules",
+ "description": "Creates or updates the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "bandwidth schedules",
+ "operation": "Delete bandwidth schedules",
+ "description": "Deletes the bandwidth schedules"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "List ArmApiRes_roles",
+ "description": "Lists or gets the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "List ArmApiRes_roles",
+ "description": "Lists or gets the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "Creates or updates ArmApiRes_roles",
+ "description": "Creates or updates the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "ArmApiRes_roles",
+ "operation": "Delete ArmApiRes_roles",
+ "description": "Deletes the ArmApiRes_roles"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "List shares",
+ "description": "Lists or gets the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "List shares",
+ "description": "Lists or gets the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "Creates or updates shares",
+ "description": "Creates or updates the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "ArmApiOp_action_refresh_shares",
+ "description": "ArmApiDesc_action_refresh_shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "shares",
+ "operation": "Delete shares",
+ "description": "Deletes the shares"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Upload certificates",
+ "description": "Upload certificate for device registration"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Creates or updates Data Box Edge devices",
+ "description": "Creates or updates the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Delete Data Box Edge devices",
+ "description": "Deletes the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "List Data Box Edge devices",
+ "description": "Lists or gets the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Creates or updates Data Box Edge devices",
+ "description": "Creates or updates the Data Box Edge devices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices",
+ "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Gets resource extended information",
+ "description": "Retrieves resource extended information"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Device network settings",
+ "operation": "List Device network settings",
+ "description": "Lists or gets the Device network settings"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Device security settings",
+ "operation": "Update security settings",
+ "description": "Update security settings"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "update summary",
+ "operation": "List update summary",
+ "description": "Lists or gets the update summary"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Scan for updates",
+ "description": "Scan for updates"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Download Updates",
+ "description": "Download Updates in device"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge devices",
+ "operation": "Install Updates",
+ "description": "Install Updates on device"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "jobs",
+ "operation": "List jobs",
+ "description": "Lists or gets the jobs"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "Creates or updates storage account credentials",
+ "description": "Creates or updates the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "List storage account credentials",
+ "description": "Lists or gets the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "List storage account credentials",
+ "description": "Lists or gets the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "storage account credentials",
+ "operation": "Delete storage account credentials",
+ "description": "Deletes the storage account credentials"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "alerts",
+ "operation": "List alerts",
+ "description": "Lists or gets the alerts"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "alerts",
+ "operation": "List alerts",
+ "description": "Lists or gets the alerts"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Read Data Box Edge device metric definition",
+ "description": "Gets the available Data Box Edge device level metrics"
+ },
+ "origin": "system",
+ "properties": {
+ "serviceSpecification": {
+ "metricSpecifications": [
+ {
+ "name": "NICReadThroughput",
+ "displayName": "Read Throughput (Network)",
+ "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "InstanceName",
+ "displayName": "Name",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "NICWriteThroughput",
+ "displayName": "Write Throughput (Network)",
+ "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "InstanceName",
+ "displayName": "Name",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudReadThroughputPerShare",
+ "displayName": "Cloud Download Throughput (Share)",
+ "displayDescription": "The download throughput to Azure from a share during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudUploadThroughputPerShare",
+ "displayName": "Cloud Upload Throughput (Share)",
+ "displayDescription": "The upload throughput to Azure from a share during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "BytesUploadedToCloudPerShare",
+ "displayName": "Cloud Bytes Uploaded (Share)",
+ "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [
+ {
+ "name": "Share",
+ "displayName": "Share",
+ "toBeExportedForShoebox": true
+ }
+ ],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT1M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "TotalCapacity",
+ "displayName": "Total Capacity",
+ "displayDescription": "Total Capacity",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Capacity",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "AvailableCapacity",
+ "displayName": "Available Capacity",
+ "displayDescription": "The available capacity in bytes during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Capacity",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudUploadThroughput",
+ "displayName": "Cloud Upload Throughput",
+ "displayDescription": "The cloud upload throughput during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "CloudReadThroughput",
+ "displayName": "Cloud Read Throughput",
+ "displayDescription": "The cloud download throughput during the reporting period.",
+ "unit": "BytesPerSecond",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ },
+ {
+ "name": "BytesUploadedToCloud",
+ "displayName": "Cloud Bytes Uploaded (Device)",
+ "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.",
+ "unit": "Bytes",
+ "aggregationType": "Average",
+ "dimensions": [],
+ "fillGapWithZero": false,
+ "category": "Transaction",
+ "supportedTimeGrainTypes": [
+ "PT5M",
+ "PT15M",
+ "PT1H"
+ ],
+ "supportedAggregationTypes": [
+ "Average",
+ "Minimum",
+ "Maximum"
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Write diagnostics setting",
+ "description": "Creates or updates the diagnostics setting for the resource"
+ },
+ "origin": "system"
+ },
+ {
+ "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read",
+ "display": {
+ "provider": "Microsoft.DataBoxEdge",
+ "resource": "Data Box Edge device",
+ "operation": "Read diagnostics setting",
+ "description": "Gets the diagnostic setting for the resource"
+ },
+ "origin": "system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsStatusGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsStatusGet.json
new file mode 100644
index 000000000000..1273d09e4146
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OperationsStatusGet.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "status": "Succeeded",
+ "startTime": "2018-12-18T02:18:51.4270267Z",
+ "endTime": "2018-12-18T03:18:51.4270267Z",
+ "percentComplete": 100,
+ "properties": {
+ "jobType": "DownloadUpdates",
+ "currentStage": "Success"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderDelete.json
new file mode 100644
index 000000000000..d22ebcd82642
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderDelete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGet.json
new file mode 100644
index 000000000000..da9d9eab267e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGet.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGetAllInDevice.json
new file mode 100644
index 000000000000..3438aa3af4a8
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderGetAllInDevice.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderPut.json
new file mode 100644
index 000000000000..342821750bd7
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/OrderPut.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "order": {
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default",
+ "name": "default",
+ "type": "dataBoxEdgeDevices/orders",
+ "properties": {
+ "contactInformation": {
+ "contactPerson": "John Mcclane",
+ "companyName": "Microsoft",
+ "phone": "(800) 426-9400",
+ "emailList": [
+ "john@microsoft.com"
+ ]
+ },
+ "shippingAddress": {
+ "addressLine1": "Microsoft Corporation",
+ "addressLine2": "One Microsoft Way",
+ "addressLine3": "Redmond",
+ "postalCode": "98052",
+ "city": "WA",
+ "state": "WA",
+ "country": "USA"
+ },
+ "currentStatus": {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": ""
+ },
+ "orderHistory": [
+ {
+ "status": "Untracked",
+ "updateDateTime": "2018-12-10T07:59:05.847Z",
+ "comments": "lorem ipsum"
+ }
+ ],
+ "serialNumber": "UDS123NSDA123",
+ "deliveryTrackingInfo": [],
+ "returnTrackingInfo": []
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutAddons.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutAddons.json
new file mode 100644
index 000000000000..6ac0210a15d8
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutAddons.json
@@ -0,0 +1,52 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "KubernetesRole",
+ "addonName": "arcName",
+ "addon": {
+ "kind": "ArcForKubernetes",
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS"
+ }
+ },
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "resourceName": "testedgedevice",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourcegroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutMonitoringConfig.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutMonitoringConfig.json
new file mode 100644
index 000000000000..5fcdd9f344cf
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/PutMonitoringConfig.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "testrole",
+ "monitoringMetricConfiguration": {
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice",
+ "properties": {
+ "metricConfigurations": [
+ {
+ "resourceId": "test",
+ "mdmAccount": "test",
+ "metricNameSpace": "test",
+ "counterSets": [
+ {
+ "counters": [
+ {
+ "name": "test"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleDelete.json
new file mode 100644
index 000000000000..d202e83a4743
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleDelete.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGet.json
new file mode 100644
index 000000000000..f2f9ffd02ac5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGet.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "kind": "IOT",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGetAllInDevice.json
new file mode 100644
index 000000000000..60ba9fdc1705
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleGetAllInDevice.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "kind": "IOT",
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleListAddOns.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleListAddOns.json
new file mode 100644
index 000000000000..b52b41582482
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RoleListAddOns.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "roleName": "IoTRole1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "subscriptionId": "0d44739e-0563-474f-97e7-24a0cdb23b29",
+ "resourceGroupName": "testrg1",
+ "resourceName": "testresource1",
+ "resourceLocation": "EastUS",
+ "version": "0.2.18",
+ "hostPlatform": "Linux",
+ "hostPlatformType": "KubernetesCluster",
+ "provisioningState": "Created"
+ },
+ "kind": "ArcForKubernetes",
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourcegroups/prpare/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/addonExamples/roles/kubernetesRole/addons/arcName",
+ "name": "arcName",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/addons"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RolePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RolePut.json
new file mode 100644
index 000000000000..d0e9ca7913af
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/RolePut.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "IoTRole1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "role": {
+ "kind": "IOT",
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {
+ "connectionString": {
+ "value": "Encrypted<>",
+ "encryptionCertThumbprint": "348586569999244",
+ "encryptionAlgorithm": "AES256"
+ }
+ }
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {
+ "connectionString": {
+ "value": "Encrypted<>",
+ "encryptionCertThumbprint": "1245475856069999244",
+ "encryptionAlgorithm": "AES256"
+ }
+ }
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "kind": "IOT",
+ "properties": {
+ "hostPlatform": "Linux",
+ "ioTDeviceDetails": {
+ "deviceId": "iotdevice",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "ioTEdgeDeviceDetails": {
+ "deviceId": "iotEdge",
+ "ioTHostHub": "iothub.azure-devices.net",
+ "authentication": {
+ "symmetricKey": {}
+ }
+ },
+ "shareMappings": [],
+ "roleStatus": "Enabled"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1",
+ "name": "IoTRole1",
+ "type": "dataBoxEdgeDevices/roles"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACDelete.json
new file mode 100644
index 000000000000..fee785c5acd2
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGet.json
new file mode 100644
index 000000000000..e9069ec83630
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGet.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "name": "sac1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGetAllInDevice.json
new file mode 100644
index 000000000000..c6015b83146d
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACGetAllInDevice.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "alias": "sac1128180128323",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "GeneralPurposeStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323",
+ "name": "sac1128180128323",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ },
+ {
+ "properties": {
+ "alias": "sac1128180128312",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312",
+ "name": "sac1128180128312",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACPut.json
new file mode 100644
index 000000000000..f99247f2c6a1
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SACPut.json
@@ -0,0 +1,50 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "sac1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "storageAccountCredential": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "accountKey": {
+ "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==",
+ "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31",
+ "encryptionAlgorithm": "AES256"
+ },
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "alias": "sac1",
+ "userName": "cisbvt",
+ "sslStatus": "Disabled",
+ "accountType": "BlobStorage"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "name": "sac1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ScanForUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ScanForUpdatesPost.json
new file mode 100644
index 000000000000..2c7ab8c13b03
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ScanForUpdatesPost.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/scanForUpdates/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SecuritySettingsUpdatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SecuritySettingsUpdatePost.json
new file mode 100644
index 000000000000..cca4d33ff1a5
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SecuritySettingsUpdatePost.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "AzureVM",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "securitySettings": {
+ "properties": {
+ "deviceAdminPassword": {
+ "value": "",
+ "encryptionAlgorithm": "AES256",
+ "encryptionCertThumbprint": ""
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/securitySettings/default/update/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareDelete.json
new file mode 100644
index 000000000000..e53da5b69385
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGet.json
new file mode 100644
index 000000000000..b991a2ace35e
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGet.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGetAllInDevice.json
new file mode 100644
index 000000000000..e0b12adec4a4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareGetAllInDevice.json
@@ -0,0 +1,48 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SharePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SharePut.json
new file mode 100644
index 000000000000..26da4e6e004a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/SharePut.json
@@ -0,0 +1,72 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "share": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Enabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "dataPolicy": "Cloud"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "",
+ "shareStatus": "Online",
+ "monitoringStatus": "Disabled",
+ "azureContainerInfo": {
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
+ "containerName": "testContainerSMB",
+ "dataFormat": "BlockBlob"
+ },
+ "accessProtocol": "SMB",
+ "userAccessRights": [
+ {
+ "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "accessType": "Change"
+ }
+ ],
+ "clientAccessRights": [],
+ "refreshDetails": {},
+ "shareMappings": [],
+ "dataPolicy": "Cloud"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare",
+ "name": "smbshare",
+ "type": "dataBoxEdgeDevices/shares"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareRefreshPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareRefreshPost.json
new file mode 100644
index 000000000000..8e9265a45cff
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/ShareRefreshPost.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "smbshare",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare/refresh/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountDelete.json
new file mode 100644
index 000000000000..8310c26100cf
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountDelete.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "storageaccount1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGet.json
new file mode 100644
index 000000000000..9f8201c2be98
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "blobstorageaccount1",
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGetAllInDevice.json
new file mode 100644
index 000000000000..058775a9b7c4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountGetAllInDevice.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountPut.json
new file mode 100644
index 000000000000..f5d64ca5c2b4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/StorageAccountPut.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "storageAccountName": "blobstorageaccount1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "storageAccount": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "description": "It's an awesome storage account",
+ "storageAccountStatus": "OK",
+ "dataPolicy": "Cloud",
+ "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt",
+ "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/",
+ "containerCount": 0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1",
+ "name": "blobstorageaccount1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerDelete.json
new file mode 100644
index 000000000000..e29d56158f83
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerDelete.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGet.json
new file mode 100644
index 000000000000..3f6d38317cfa
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGet.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGetAllInDevice.json
new file mode 100644
index 000000000000..3d1919693864
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerGetAllInDevice.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerPut.json
new file mode 100644
index 000000000000..721f852d5ced
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerPut.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "trigger1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "trigger": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "kind": "FileEvent"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "customContextTag": "CustomContextTags-1235346475",
+ "sourceInfo": {
+ "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1"
+ },
+ "sinkInfo": {
+ "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1"
+ }
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1",
+ "name": "trigger1",
+ "type": "dataBoxEdgeDevices/triggers",
+ "kind": "FileEvent"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerSupportPackage.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerSupportPackage.json
new file mode 100644
index 000000000000..9f5363c433c3
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/TriggerSupportPackage.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "triggerSupportPackageRequest": {
+ "properties": {
+ "minimumTimeStamp": "2018-12-18T02:18:51.4270267Z",
+ "maximumTimeStamp": "2018-12-18T02:19:51.4270267Z",
+ "include": "DefaultWithDumps"
+ }
+ }
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggerSupportPackage/operationResults/00000"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json
new file mode 100644
index 000000000000..f48f47fae8fb
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticProactiveLogCollectionSettings.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "proactiveLogCollectionSettings": {
+ "properties": {
+ "userConsent": "Enabled"
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "userConsent": "Disabled"
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-5428209/diagnosticProactiveLogCollectionSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json
new file mode 100644
index 000000000000..471b7d409cef
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateDiagnosticRemoteSupportSettings.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "159a00c7-8543-4343-9435-263ac87df3bb",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "diagnosticRemoteSupportSettings": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2021-07-07T00:00:00+00:00",
+ "remoteApplicationType": "Powershell"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "202": {},
+ "200": {
+ "body": {
+ "properties": {
+ "remoteSupportSettingsList": [
+ {
+ "remoteApplicationType": "Powershell",
+ "accessLevel": "ReadWrite",
+ "expirationTimeStampInUTC": "2500-09-14T00:00:00+00:00"
+ }
+ ]
+ },
+ "id": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/dbe-autobot-154c8a4/diagnosticRemoteSupportSettings/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/diagnosticSettings"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateSummaryGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateSummaryGet.json
new file mode 100644
index 000000000000..a1faf6d87b67
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UpdateSummaryGet.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "deviceVersionNumber": "2.1.1377.2170",
+ "friendlyDeviceVersionName": "Azure Stack Edge 2010",
+ "deviceLastScannedDateTime": "2021-03-17T19:51:51.7864634Z",
+ "lastCompletedScanJobDateTime": "2021-03-17T19:47:46.1595547Z",
+ "lastDownloadJobStatus": "Invalid",
+ "lastInstallJobStatus": "Invalid",
+ "totalNumberOfUpdatesAvailable": 1,
+ "totalNumberOfUpdatesPendingDownload": 1,
+ "totalNumberOfUpdatesPendingInstall": 1,
+ "rebootBehavior": "NeverReboots",
+ "ongoingUpdateOperation": "Install",
+ "updateTitles": [
+ "Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R"
+ ],
+ "totalUpdateSizeInBytes": 4260898192.0
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default",
+ "name": "default",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UploadCertificatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UploadCertificatePost.json
new file mode 100644
index 000000000000..57104176a918
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UploadCertificatePost.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "parameters": {
+ "properties": {
+ "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw=="
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "authType": "AzureActiveDirectory",
+ "resourceId": "392799901267771",
+ "aadAuthority": "https://login.windows.net",
+ "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909",
+ "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68",
+ "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4",
+ "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/"
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserDelete.json
new file mode 100644
index 000000000000..b08eba15056a
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserDelete.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com//subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1/operationResults/00000"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGet.json
new file mode 100644
index 000000000000..d9052e4b3498
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGet.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ },
+ "202": {}
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGetAllInDevice.json
new file mode 100644
index 000000000000..c5189d350bc4
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserGetAllInDevice.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ]
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
+ "name": "user2",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ },
+ {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserPut.json
new file mode 100644
index 000000000000..18e9b3404f5d
--- /dev/null
+++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2023-01-01-preview/examples/UserPut.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01-preview",
+ "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce",
+ "resourceGroupName": "GroupForEdgeAutomation",
+ "deviceName": "testedgedevice",
+ "name": "user1",
+ "Content-Type": [
+ "application/json; charset=utf-8"
+ ],
+ "Content-Length": [
+ "200"
+ ],
+ "x-ms-client-request-id": [
+ "a93b39a3-1ff4-42b8-a56f-43368d47e37a"
+ ],
+ "accept-language": [
+ "en-US"
+ ],
+ "user": {
+ "properties": {
+ "encryptedPassword": {
+ "value": "",
+ "encryptionAlgorithm": "None",
+ "encryptionCertThumbprint": "blah"
+ },
+ "userType": "Share"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "userType": "Share"
+ },
+ "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1",
+ "name": "user1",
+ "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users"
+ }
+ },
+ "202": {}
+ }
+}
diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md
index 96e32d032f4e..48a14ccff980 100644
--- a/specification/databoxedge/resource-manager/readme.md
+++ b/specification/databoxedge/resource-manager/readme.md
@@ -28,6 +28,22 @@ These are the global settings for the DataBox Edge API.
openapi-type: arm
tag: package-2022-03-01
```
+### Tag: package-2023-01-01-preview
+
+These settings apply only when `--tag=package-2023-01-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2023-01-01-preview'
+input-file:
+- Microsoft.DataBoxEdge/preview/2023-01-01-preview/databoxedge.json
+```
+### Tag: package-2022-12-01-preview
+
+These settings apply only when `--tag=package-2022-12-01-preview` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-12-01-preview'
+input-file:
+- Microsoft.DataBoxEdge/preview/2022-12-01-preview/databoxedge.json
+```
### Tag: package-2022-04-01-preview
These settings apply only when `--tag=package-2022-04-01-preview` is specified on the command line.
diff --git a/specification/databoxedge/resource-manager/readme.python.md b/specification/databoxedge/resource-manager/readme.python.md
index 9e3dafb58b02..4b4a250224ca 100644
--- a/specification/databoxedge/resource-manager/readme.python.md
+++ b/specification/databoxedge/resource-manager/readme.python.md
@@ -23,6 +23,7 @@ Generate all API versions currently shipped for this package
```yaml $(python)
multiapi: true
batch:
+ - tag: package-2022-03-01
- tag: package-2021-02-01
- tag: package-2021-02-01-preview
- tag: package-2020-12-01
@@ -39,6 +40,15 @@ batch:
output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/
perform-load: false
```
+### Tag: package-2022-03-01 and python
+
+These settings apply only when `--tag=package-2022-03-01 --python` is specified on the command line.
+Please also specify `--python-sdks-folder=`.
+
+``` yaml $(tag) == 'package-2022-03-01' && $(python)
+namespace: azure.mgmt.databoxedge.v2022_03_01
+output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/v2022_03_01
+```
### Tag: package-2021-02-01 and python
These settings apply only when `--tag=package-2021-02-01 --python` is specified on the command line.
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json
index e1d44fa4def0..fb20d55e2bbb 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json
@@ -318,6 +318,10 @@
"identity": {
"$ref": "#/definitions/IdentityData"
},
+ "systemData": {
+ "description": "The system metadata relating to this resource",
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData"
+ },
"properties": {
"description": "Azure Databricks accessConnector properties",
"$ref": "#/definitions/AccessConnectorProperties"
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/databricks.json
index f29f2d54dd86..dd7ed36376df 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/databricks.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/databricks.json
@@ -795,6 +795,7 @@
"$ref": "#/definitions/ManagedIdentityConfiguration"
},
"diskEncryptionSetId": {
+ "readOnly": true,
"type": "string",
"description": "The resource Id of the managed disk encryption set."
},
@@ -1413,7 +1414,7 @@
"description": "The object that represents the operation.",
"properties": {
"provider": {
- "description": "Service provider: Microsoft.ResourceProvider",
+ "description": "Service provider: ex Microsoft.Databricks",
"type": "string"
},
"resource": {
@@ -1423,6 +1424,10 @@
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
+ },
+ "description": {
+ "description": "Description for the resource operation.",
+ "type": "string"
}
}
}
@@ -1578,6 +1583,13 @@
"description": "Private endpoint",
"$ref": "#/definitions/PrivateEndpoint"
},
+ "groupIds": {
+ "type": "array",
+ "description": "GroupIds from the private link service resource.",
+ "items": {
+ "type": "string"
+ }
+ },
"privateLinkServiceConnectionState": {
"title": "Private link service service connection state",
"description": "Private endpoint connection state",
@@ -1625,7 +1637,7 @@
"type": "string",
"description": "The description for the current state of a private endpoint connection"
},
- "actionRequired": {
+ "actionsRequired": {
"type": "string",
"description": "Actions required for a private endpoint connection"
}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/ListPrivateEndpointConnections.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/ListPrivateEndpointConnections.json
index ed59ac4583e7..e821186441c8 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/ListPrivateEndpointConnections.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/ListPrivateEndpointConnections.json
@@ -20,7 +20,7 @@
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by johndoe@company.com",
- "actionRequired": "None"
+ "actionsRequired": "None"
},
"provisioningState": "Succeeded"
}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsGet.json
index bbc32f367219..b07e6171ac2c 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsGet.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsGet.json
@@ -19,7 +19,7 @@
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request!",
- "actionRequired": "None"
+ "actionsRequired": "None"
},
"provisioningState": "Succeeded"
}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json
index bb091929d565..cd6c8e9349a9 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/PrivateEndpointConnectionsUpdate.json
@@ -27,7 +27,7 @@
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by databricksadmin@contoso.com",
- "actionRequired": "None"
+ "actionsRequired": "None"
},
"provisioningState": "Succeeded"
}
@@ -45,7 +45,7 @@
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by databricksadmin@contoso.com",
- "actionRequired": "None"
+ "actionsRequired": "None"
},
"provisioningState": "Succeeded"
}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/WorkspaceGetParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/WorkspaceGetParameters.json
index ac0c996e4dd7..f49078481721 100644
--- a/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/WorkspaceGetParameters.json
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/preview/2022-04-01-preview/examples/WorkspaceGetParameters.json
@@ -65,7 +65,7 @@
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-Approved",
- "actionRequired": "None"
+ "actionsRequired": "None"
},
"provisioningState": "Succeeded"
}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/databricks.json
new file mode 100644
index 000000000000..46a9170830d3
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/databricks.json
@@ -0,0 +1,1795 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "AzureDatabricksManagementClient",
+ "version": "2023-02-01",
+ "description": "These APIs allow end users to operate on Azure Databricks Workspace resources."
+ },
+ "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.Databricks/workspaces/{workspaceName}": {
+ "get": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_Get",
+ "description": "Gets the workspace.",
+ "x-ms-examples": {
+ "Get a workspace": {
+ "$ref": "./examples/WorkspaceGet.json"
+ },
+ "Get a workspace with custom parameters": {
+ "$ref": "./examples/WorkspaceGetParameters.json"
+ },
+ "Get a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": {
+ "$ref": "./examples/WorkspaceManagedDiskEncryptionGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the workspace.",
+ "schema": {
+ "$ref": "#/definitions/Workspace"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_Delete",
+ "description": "Deletes the workspace.",
+ "x-ms-examples": {
+ "Delete a workspace": {
+ "$ref": "./examples/WorkspaceDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "NoContent"
+ },
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_CreateOrUpdate",
+ "description": "Creates a new workspace.",
+ "x-ms-examples": {
+ "Create or update workspace": {
+ "$ref": "./examples/WorkspaceCreate.json"
+ },
+ "Create or update workspace with custom parameters": {
+ "$ref": "./examples/WorkspaceCreateWithParameters.json"
+ },
+ "Create a workspace which is ready for Customer-Managed Key (CMK) encryption": {
+ "$ref": "./examples/PrepareEncryption.json"
+ },
+ "Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption": {
+ "$ref": "./examples/EnableEncryption.json"
+ },
+ "Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace": {
+ "$ref": "./examples/DisableEncryption.json"
+ },
+ "Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": {
+ "$ref": "./examples/WorkspaceManagedDiskEncryptionCreate.json"
+ },
+ "Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks": {
+ "$ref": "./examples/WorkspaceManagedDiskEncryptionUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Workspace"
+ },
+ "description": "Parameters supplied to the create or update a workspace."
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Created - Returns information about the workspace, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/Workspace"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the workspace, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/Workspace"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_Update",
+ "description": "Updates a workspace.",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkspaceUpdate"
+ },
+ "description": "The update to the workspace."
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully updated the workspace.",
+ "schema": {
+ "$ref": "#/definitions/Workspace"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update a workspace's tags.": {
+ "$ref": "./examples/WorkspaceUpdate.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces": {
+ "get": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_ListByResourceGroup",
+ "description": "Gets all the workspaces within a resource group.",
+ "x-ms-examples": {
+ "Lists workspaces": {
+ "$ref": "./examples/WorkspacesListByResourceGroup.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of workspaces.",
+ "schema": {
+ "$ref": "#/definitions/WorkspaceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Databricks/workspaces": {
+ "get": {
+ "tags": [
+ "Workspaces"
+ ],
+ "operationId": "Workspaces_ListBySubscription",
+ "description": "Gets all the workspaces within a subscription.",
+ "x-ms-examples": {
+ "Lists workspaces": {
+ "$ref": "./examples/WorkspacesListBySubscription.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of workspaces.",
+ "schema": {
+ "$ref": "#/definitions/WorkspaceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Databricks/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Lists all of the available RP operations.",
+ "x-ms-examples": {
+ "Operations": {
+ "$ref": "./examples/OperationsList.json"
+ }
+ },
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Resource Provider error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "summary": "List private link resources",
+ "description": "List private link resources for a given workspace",
+ "operationId": "PrivateLinkResources_List",
+ "x-ms-examples": {
+ "List private link resources": {
+ "$ref": "./examples/ListPrivateLinkResources.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of private link resources",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourcesList"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateLinkResources/{groupId}": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "summary": "Get the specified private link resource",
+ "description": "Get the specified private link resource for the given group id (sub-resource)",
+ "operationId": "PrivateLinkResources_Get",
+ "x-ms-examples": {
+ "Get a private link resource": {
+ "$ref": "./examples/PrivateLinkResourcesGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the specified of private link resource",
+ "schema": {
+ "$ref": "#/definitions/GroupIdInformation"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "List private endpoint connections",
+ "description": "List private endpoint connections of the workspace",
+ "operationId": "PrivateEndpointConnections_List",
+ "x-ms-examples": {
+ "List private endpoint connections": {
+ "$ref": "./examples/ListPrivateEndpointConnections.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns list of private endpoint connections for a workspace",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionsList"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Get private endpoint connection",
+ "description": "Get a private endpoint connection properties for a workspace",
+ "operationId": "PrivateEndpointConnections_Get",
+ "x-ms-examples": {
+ "Get a private endpoint connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the private endpoint connection properties of a workspace",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PUT",
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Update private endpoint connection status",
+ "description": "Update the status of a private endpoint connection with the specified name",
+ "operationId": "PrivateEndpointConnections_Create",
+ "x-ms-examples": {
+ "Update a private endpoint connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "name": "privateEndpointConnection",
+ "in": "body",
+ "description": "The private endpoint connection with updated properties",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK -- Update the private endpoint connection properties successfully.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "202": {
+ "description": "Accepted - 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"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DELETE",
+ "PrivateEndpointConnections"
+ ],
+ "summary": "Remove private endpoint connection",
+ "description": "Remove private endpoint connection with the specified name",
+ "operationId": "PrivateEndpointConnections_Delete",
+ "x-ms-examples": {
+ "Remove a private endpoint connection": {
+ "$ref": "./examples/PrivateEndpointConnectionsDelete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - 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."
+ },
+ "200": {
+ "description": "OK - Returns the status of polling request for the delete operation."
+ },
+ "204": {
+ "description": "No Content - PrivateEndpoint does not exist."
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/outboundNetworkDependenciesEndpoints": {
+ "get": {
+ "tags": [
+ "OutboundNetworkDependenciesEndpoints"
+ ],
+ "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified Workspace.",
+ "description": "Gets the list of endpoints that VNET Injected Workspace calls Azure Databricks Control Plane. You must configure outbound access with these endpoints. For more information, see https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr",
+ "operationId": "OutboundNetworkDependenciesEndpoints_List",
+ "x-ms-examples": {
+ "List OutboundNetworkDependenciesEndpoints by Workspace": {
+ "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The response contains list of outbound network dependency endpoints",
+ "schema": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Workspace": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WorkspaceProperties",
+ "description": "The workspace properties."
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the resource."
+ },
+ "systemData": {
+ "description": "The system metadata relating to this resource",
+ "type": "object",
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/TrackedResource"
+ }
+ ],
+ "description": "Information about workspace."
+ },
+ "WorkspaceProperties": {
+ "properties": {
+ "managedResourceGroupId": {
+ "type": "string",
+ "description": "The managed resource group Id."
+ },
+ "parameters": {
+ "$ref": "#/definitions/WorkspaceCustomParameters",
+ "description": "The workspace's custom parameters."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "$ref": "#/definitions/ProvisioningState",
+ "description": "The workspace provisioning state."
+ },
+ "uiDefinitionUri": {
+ "type": "string",
+ "description": "The blob URI where the UI definition file is located."
+ },
+ "authorizations": {
+ "description": "The workspace provider authorizations.",
+ "type": "array",
+ "x-ms-identifiers": [],
+ "items": {
+ "$ref": "#/definitions/WorkspaceProviderAuthorization"
+ }
+ },
+ "createdBy": {
+ "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace.",
+ "$ref": "#/definitions/CreatedBy"
+ },
+ "updatedBy": {
+ "description": "Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.",
+ "$ref": "#/definitions/CreatedBy"
+ },
+ "createdDateTime": {
+ "description": "Specifies the date and time when the workspace is created.",
+ "$ref": "#/definitions/CreatedDateTime"
+ },
+ "workspaceId": {
+ "readOnly": true,
+ "description": "The unique identifier of the databricks workspace in databricks control plane.",
+ "type": "string"
+ },
+ "workspaceUrl": {
+ "readOnly": true,
+ "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'",
+ "type": "string"
+ },
+ "storageAccountIdentity": {
+ "description": "The details of Managed Identity of Storage Account",
+ "$ref": "#/definitions/ManagedIdentityConfiguration"
+ },
+ "managedDiskIdentity": {
+ "description": "The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption",
+ "$ref": "#/definitions/ManagedIdentityConfiguration"
+ },
+ "diskEncryptionSetId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource Id of the managed disk encryption set."
+ },
+ "encryption": {
+ "type": "object",
+ "description": "Encryption properties for databricks workspace",
+ "properties": {
+ "entities": {
+ "$ref": "#/definitions/EncryptionEntitiesDefinition",
+ "description": "Encryption entities definition for the workspace."
+ }
+ },
+ "required": [
+ "entities"
+ ]
+ },
+ "privateEndpointConnections": {
+ "readOnly": true,
+ "description": "Private endpoint connections created on the workspace",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "publicNetworkAccess": {
+ "type": "string",
+ "description": "The network access type for accessing workspace. Set value to disabled to access workspace only via private link.",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "PublicNetworkAccess"
+ }
+ },
+ "requiredNsgRules": {
+ "type": "string",
+ "description": "Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.",
+ "enum": [
+ "AllRules",
+ "NoAzureDatabricksRules",
+ "NoAzureServiceRules"
+ ],
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RequiredNsgRules"
+ }
+ }
+ },
+ "required": [
+ "managedResourceGroupId"
+ ],
+ "description": "The workspace properties."
+ },
+ "TrackedResource": {
+ "description": "The resource model definition for a ARM tracked top level resource",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-mutability": [
+ "read",
+ "create",
+ "update"
+ ],
+ "description": "Resource tags."
+ },
+ "location": {
+ "type": "string",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "The geo-location where the resource lives"
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "Resource": {
+ "description": "The core properties of ARM resources",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The SKU name."
+ },
+ "tier": {
+ "type": "string",
+ "description": "The SKU tier."
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "description": "SKU for the resource."
+ },
+ "ProvisioningState": {
+ "description": "Provisioning status of the workspace.",
+ "readOnly": true,
+ "enum": [
+ "Accepted",
+ "Running",
+ "Ready",
+ "Creating",
+ "Created",
+ "Deleting",
+ "Deleted",
+ "Canceled",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "PeeringProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Updating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PeeringProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "ManagedIdentityConfiguration": {
+ "description": "The Managed Identity details for storage account.",
+ "properties": {
+ "principalId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The objectId of the Managed Identity that is linked to the Managed Storage account.",
+ "readOnly": true
+ },
+ "tenantId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The tenant Id where the Managed Identity is created.",
+ "readOnly": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned.",
+ "readOnly": true
+ }
+ }
+ },
+ "WorkspaceCustomParameterType": {
+ "description": "Provisioning status of the workspace.",
+ "readOnly": true,
+ "enum": [
+ "Bool",
+ "Object",
+ "String"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomParameterType",
+ "modelAsString": true
+ }
+ },
+ "WorkspaceCustomBooleanParameter": {
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/WorkspaceCustomParameterType",
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": "boolean",
+ "description": "The value which should be used for this field."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The value which should be used for this field."
+ },
+ "WorkspaceCustomObjectParameter": {
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/WorkspaceCustomParameterType",
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": "object",
+ "description": "The value which should be used for this field."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The value which should be used for this field."
+ },
+ "WorkspaceCustomStringParameter": {
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/WorkspaceCustomParameterType",
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "type": "string",
+ "description": "The value which should be used for this field."
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "description": "The Value."
+ },
+ "WorkspaceCustomParameters": {
+ "properties": {
+ "amlWorkspaceId": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "The ID of a Azure Machine Learning workspace to link with Databricks workspace"
+ },
+ "customVirtualNetworkId": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "The ID of a Virtual Network where this Databricks Cluster should be created"
+ },
+ "customPublicSubnetName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "The name of a Public Subnet within the Virtual Network"
+ },
+ "customPrivateSubnetName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "The name of the Private Subnet within the Virtual Network"
+ },
+ "enableNoPublicIp": {
+ "$ref": "#/definitions/WorkspaceCustomBooleanParameter",
+ "description": "Should the Public IP be Disabled?"
+ },
+ "loadBalancerBackendPoolName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP)."
+ },
+ "loadBalancerId": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace."
+ },
+ "natGatewayName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets."
+ },
+ "publicIpName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Name of the Public IP for No Public IP workspace with managed vNet."
+ },
+ "prepareEncryption": {
+ "$ref": "#/definitions/WorkspaceCustomBooleanParameter",
+ "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account."
+ },
+ "encryption": {
+ "$ref": "#/definitions/WorkspaceEncryptionParameter",
+ "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace."
+ },
+ "requireInfrastructureEncryption": {
+ "$ref": "#/definitions/WorkspaceCustomBooleanParameter",
+ "description": "A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest."
+ },
+ "storageAccountName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Default DBFS storage account name."
+ },
+ "storageAccountSkuName": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs."
+ },
+ "vnetAddressPrefix": {
+ "$ref": "#/definitions/WorkspaceCustomStringParameter",
+ "description": "Address prefix for Managed virtual network. Default value for this input is 10.139."
+ },
+ "resourceTags": {
+ "$ref": "#/definitions/WorkspaceCustomObjectParameter",
+ "readOnly": true,
+ "description": "Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level."
+ }
+ },
+ "description": "Custom Parameters used for Cluster Creation."
+ },
+ "CreatedDateTime": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time stamp when the workspace was created.",
+ "readOnly": true
+ },
+ "CreatedBy": {
+ "properties": {
+ "oid": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The Object ID that created the workspace.",
+ "readOnly": true
+ },
+ "puid": {
+ "type": "string",
+ "description": "The Personal Object ID corresponding to the object ID above",
+ "readOnly": true
+ },
+ "applicationId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.",
+ "readOnly": true
+ }
+ },
+ "description": "Provides details of the entity that created/updated the workspace."
+ },
+ "WorkspaceEncryptionParameter": {
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/WorkspaceCustomParameterType",
+ "description": "The type of variable that this is"
+ },
+ "value": {
+ "$ref": "#/definitions/Encryption",
+ "description": "The value which should be used for this field."
+ }
+ },
+ "description": "The object that contains details of encryption used on the workspace."
+ },
+ "Encryption": {
+ "properties": {
+ "keySource": {
+ "type": "string",
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault",
+ "enum": [
+ "Default",
+ "Microsoft.Keyvault"
+ ],
+ "x-ms-enum": {
+ "name": "KeySource",
+ "modelAsString": true
+ },
+ "default": "Default"
+ },
+ "KeyName": {
+ "type": "string",
+ "description": "The name of KeyVault key."
+ },
+ "keyversion": {
+ "type": "string",
+ "description": "The version of KeyVault key.",
+ "x-ms-client-name": "KeyVersion"
+ },
+ "keyvaulturi": {
+ "type": "string",
+ "description": "The Uri of KeyVault.",
+ "x-ms-client-name": "KeyVaultUri"
+ }
+ },
+ "description": "The object that contains details of encryption used on the workspace."
+ },
+ "EncryptionEntitiesDefinition": {
+ "properties": {
+ "managedServices": {
+ "type": "object",
+ "description": "Encryption properties for the databricks managed services.",
+ "$ref": "#/definitions/EncryptionV2"
+ },
+ "managedDisk": {
+ "type": "object",
+ "description": "Encryption properties for the databricks managed disks.",
+ "$ref": "#/definitions/ManagedDiskEncryption"
+ }
+ },
+ "description": "Encryption entities for databricks workspace resource."
+ },
+ "EncryptionV2": {
+ "properties": {
+ "keySource": {
+ "type": "string",
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault",
+ "enum": [
+ "Microsoft.Keyvault"
+ ],
+ "x-ms-enum": {
+ "name": "EncryptionKeySource",
+ "modelAsString": true
+ }
+ },
+ "keyVaultProperties": {
+ "properties": {
+ "keyVaultUri": {
+ "type": "string",
+ "description": "The Uri of KeyVault."
+ },
+ "keyName": {
+ "type": "string",
+ "description": "The name of KeyVault key."
+ },
+ "keyVersion": {
+ "type": "string",
+ "description": "The version of KeyVault key."
+ }
+ },
+ "required": [
+ "keyVaultUri",
+ "keyName",
+ "keyVersion"
+ ],
+ "description": "Key Vault input properties for encryption."
+ }
+ },
+ "required": [
+ "keySource"
+ ],
+ "description": "The object that contains details of encryption used on the workspace."
+ },
+ "ManagedDiskEncryption": {
+ "type": "object",
+ "properties": {
+ "keySource": {
+ "type": "string",
+ "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault",
+ "enum": [
+ "Microsoft.Keyvault"
+ ],
+ "x-ms-enum": {
+ "name": "EncryptionKeySource",
+ "modelAsString": true
+ }
+ },
+ "keyVaultProperties": {
+ "type": "object",
+ "properties": {
+ "keyVaultUri": {
+ "type": "string",
+ "description": "The URI of KeyVault."
+ },
+ "keyName": {
+ "type": "string",
+ "description": "The name of KeyVault key."
+ },
+ "keyVersion": {
+ "type": "string",
+ "description": "The version of KeyVault key."
+ }
+ },
+ "required": [
+ "keyVaultUri",
+ "keyName",
+ "keyVersion"
+ ],
+ "description": "Key Vault input properties for encryption."
+ },
+ "rotationToLatestKeyVersionEnabled": {
+ "type": "boolean",
+ "description": "Indicate whether the latest key version should be automatically used for Managed Disk Encryption."
+ }
+ },
+ "required": [
+ "keySource",
+ "keyVaultProperties"
+ ],
+ "description": "The object that contains details of encryption used on the workspace."
+ },
+ "WorkspaceProviderAuthorization": {
+ "properties": {
+ "principalId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources."
+ },
+ "roleDefinitionId": {
+ "type": "string",
+ "format": "uuid",
+ "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group."
+ }
+ },
+ "required": [
+ "principalId",
+ "roleDefinitionId"
+ ],
+ "description": "The workspace provider authorization."
+ },
+ "WorkspaceUpdate": {
+ "description": "An update to a workspace.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ErrorDetail": {
+ "title": "Error details.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error's code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A human readable error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "Indicates which property in the request is responsible for the error.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "ErrorInfo": {
+ "title": "The code and message for an error.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "A machine readable error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A human readable error message.",
+ "type": "string"
+ },
+ "details": {
+ "description": "error details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorDetail"
+ }
+ },
+ "innererror": {
+ "description": "Inner error details if they exist.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "ErrorResponse": {
+ "title": "Error response.",
+ "description": "Contains details when the response code indicates an error.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error details.",
+ "$ref": "#/definitions/ErrorInfo"
+ }
+ },
+ "required": [
+ "error"
+ ]
+ },
+ "WorkspaceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Workspace"
+ },
+ "description": "The array of workspaces."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of workspaces."
+ },
+ "Operation": {
+ "description": "REST API operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: ex Microsoft.Databricks",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description for the resource operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.",
+ "properties": {
+ "value": {
+ "type": "array",
+ "x-ms-identifiers": [],
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "description": "List of Resource Provider operations supported by the Resource Provider resource provider."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "PrivateLinkResourcesList": {
+ "description": "The available private link resources for a workspace",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of available private link resources for a workspace",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GroupIdInformation"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of private link resources."
+ }
+ }
+ },
+ "GroupIdInformation": {
+ "description": "The group information for creating a private endpoint on a workspace",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource identifier."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource name."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource type."
+ },
+ "properties": {
+ "description": "The group id properties.",
+ "type": "object",
+ "x-ms-client-flatten": false,
+ "$ref": "#/definitions/GroupIdInformationProperties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "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": "List of private link connections.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnection"
+ },
+ "description": "The list of returned private endpoint connection."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of endpoint connections."
+ }
+ }
+ },
+ "PrivateEndpointConnection": {
+ "description": "The private endpoint connection of a workspace",
+ "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."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The resource type."
+ },
+ "properties": {
+ "type": "object",
+ "description": "The private endpoint connection properties.",
+ "x-ms-client-flatten": false,
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties"
+ }
+ },
+ "required": [
+ "properties"
+ ]
+ },
+ "PrivateEndpointConnectionProperties": {
+ "description": "The properties of a private endpoint connection",
+ "type": "object",
+ "properties": {
+ "privateEndpoint": {
+ "title": "Private endpoint",
+ "description": "Private endpoint",
+ "$ref": "#/definitions/PrivateEndpoint"
+ },
+ "groupIds": {
+ "type": "array",
+ "description": "GroupIds from the private link service resource.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "privateLinkServiceConnectionState": {
+ "title": "Private link service service connection state",
+ "description": "Private endpoint connection state",
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState"
+ },
+ "provisioningState": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
+ "description": "Provisioning state of the private endpoint connection."
+ }
+ },
+ "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"
+ ]
+ },
+ "PrivateEndpointConnectionProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Creating",
+ "Updating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "EndpointDependency": {
+ "description": "A domain name or IP address the Workspace is reaching at.",
+ "type": "object",
+ "properties": {
+ "domainName": {
+ "description": "The domain name of the dependency.",
+ "type": "string"
+ },
+ "endpointDetails": {
+ "description": "The Ports used when connecting to domainName.",
+ "type": "array",
+ "x-ms-identifiers": [],
+ "items": {
+ "$ref": "#/definitions/EndpointDetail"
+ }
+ }
+ }
+ },
+ "EndpointDetail": {
+ "description": "Connect information from the Workspace 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 the connection to be created from the Workspace to this IpAddress at this Port.",
+ "type": "number"
+ },
+ "isAccessible": {
+ "description": "Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.",
+ "type": "boolean"
+ }
+ }
+ },
+ "OutboundEnvironmentEndpoint": {
+ "description": "Egress endpoints which Workspace connects to for common purposes.",
+ "type": "object",
+ "properties": {
+ "category": {
+ "description": "The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "The endpoints that Workspace connect to",
+ "type": "array",
+ "x-ms-identifiers": [],
+ "items": {
+ "$ref": "#/definitions/EndpointDependency"
+ }
+ }
+ }
+ },
+ "OutboundEnvironmentEndpointCollection": {
+ "description": "Collection of outbound network dependency endpoints",
+ "type": "array",
+ "x-ms-identifiers": [],
+ "items": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpoint"
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation."
+ },
+ "ResourceGroupName": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "WorkspaceName": {
+ "name": "workspaceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the workspace.",
+ "minLength": 3,
+ "maxLength": 64,
+ "x-ms-parameter-location": "method"
+ },
+ "PeeringNameParameter": {
+ "name": "peeringName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the workspace vNet peering.",
+ "x-ms-parameter-location": "method"
+ },
+ "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/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/DisableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/DisableEncryption.json
new file mode 100644
index 000000000000..8781ef5ca8a3
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/DisableEncryption.json
@@ -0,0 +1,130 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "encryption": {
+ "value": {
+ "keySource": "Default"
+ }
+ }
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "sku": {
+ "name": "premium"
+ },
+ "location": "East US 2",
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "customPrivateSubnetName": {
+ "type": "String",
+ "value": "PrivateBob"
+ },
+ "customPublicSubnetName": {
+ "type": "String",
+ "value": "PublicSarah"
+ },
+ "customVirtualNetworkId": {
+ "type": "String",
+ "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
+ },
+ "prepareEncryption": {
+ "type": "Bool",
+ "value": true
+ },
+ "encryption": {
+ "type": "Object",
+ "value": {
+ "keySource": "Default"
+ }
+ }
+ },
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "storageAccountIdentity": {
+ "principalId": "55555555-5555-5555-5555-555555555555",
+ "tenantId": "66666666-6666-6666-6666-666666666666",
+ "type": "SystemAssigned"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "storageAccountIdentity": {
+ "principalId": "55555555-5555-5555-5555-555555555555",
+ "tenantId": "66666666-6666-6666-6666-666666666666",
+ "type": "SystemAssigned"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/EnableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/EnableEncryption.json
new file mode 100644
index 000000000000..fd360f50811a
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/EnableEncryption.json
@@ -0,0 +1,139 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "prepareEncryption": {
+ "value": true
+ },
+ "encryption": {
+ "value": {
+ "keySource": "Microsoft.Keyvault",
+ "keyvaulturi": "https://myKeyVault.vault.azure.net/",
+ "KeyName": "myKeyName",
+ "keyversion": "00000000000000000000000000000000"
+ }
+ }
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "sku": {
+ "name": "premium"
+ },
+ "location": "East US 2",
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "customPrivateSubnetName": {
+ "type": "String",
+ "value": "PrivateBob"
+ },
+ "customPublicSubnetName": {
+ "type": "String",
+ "value": "PublicSarah"
+ },
+ "customVirtualNetworkId": {
+ "type": "String",
+ "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
+ },
+ "prepareEncryption": {
+ "type": "Bool",
+ "value": true
+ },
+ "encryption": {
+ "type": "Object",
+ "value": {
+ "keySource": "Microsoft.Keyvault",
+ "keyvaulturi": "https://myKeyVault.vault.azure.net/",
+ "KeyName": "myKeyName",
+ "keyversion": "00000000000000000000000000000000"
+ }
+ }
+ },
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "storageAccountIdentity": {
+ "principalId": "55555555-5555-5555-5555-555555555555",
+ "tenantId": "66666666-6666-6666-6666-666666666666",
+ "type": "SystemAssigned"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "storageAccountIdentity": {
+ "principalId": "55555555-5555-5555-5555-555555555555",
+ "tenantId": "66666666-6666-6666-6666-666666666666",
+ "type": "SystemAssigned"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateEndpointConnections.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..f8ab79fae659
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateEndpointConnections.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
+ "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by johndoe@company.com",
+ "actionsRequired": "None"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateLinkResources.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateLinkResources.json
new file mode 100644
index 000000000000..bf35bc099f9c
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/ListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api",
+ "name": "databricks_ui_api",
+ "type": "Microsoft.Databricks/workspaces/PrivateLinkResources",
+ "properties": {
+ "groupId": "databricks_ui_api",
+ "requiredMembers": [
+ "databricks_ui_api"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azuredatabricks.net"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OperationsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OperationsList.json
new file mode 100644
index 000000000000..4d29faa898e5
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OperationsList.json
@@ -0,0 +1,128 @@
+{
+ "parameters": {
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "name": "Microsoft.Databricks/workspaces/read",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Workspace",
+ "operation": "List Workspaces",
+ "description": "Retrieves a list of workspaces."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/write",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Workspace",
+ "operation": "Create Workspace",
+ "description": "Creates an workspace."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/delete",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Workspace",
+ "operation": "Remove Workspace",
+ "description": "Removes an workspace."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/read",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Virtual Network Peering",
+ "operation": "Get Virtual Network Peering",
+ "description": "Gets the virtual network peering."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/write",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Virtual Network Peering",
+ "operation": "Add Virtual Network Peering",
+ "description": "Add or modify virtual network peering"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/virtualNetworkPeerings/delete",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Virtual Network Peering",
+ "operation": "Delete Virtual Network Peering",
+ "description": "Deletes a virtual network peering"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/PrivateLinkResources/read",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Private Link Resources",
+ "operation": "List Private Link Resources",
+ "description": "Retrieve List of Private Link Resources"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/read",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Private Endpoint Connection",
+ "operation": "List Private Endpoint Connections",
+ "description": "Retrieve List of Private Endpoint Connections"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/write",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Private Endpoint Connection",
+ "operation": "Update Private Endpoint Connection",
+ "description": "Update a virtual network peering"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/workspaces/PrivateEndpointConnections/delete",
+ "display": {
+ "provider": "Microsoft Databricks",
+ "resource": "Private Endpoint Connection",
+ "operation": "Delete Private Endpoint Connection",
+ "description": "Delete a Private Endpoint Connection"
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/accessConnectors/read",
+ "display": {
+ "provider": "Azure Databricks",
+ "resource": "AccessConnector",
+ "operation": "List Azure Databricks Access Connector",
+ "description": "Retrieves a list of Azure Databricks Access Connector."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/accessConnectors/write",
+ "display": {
+ "provider": "Azure Databricks",
+ "resource": "AccessConnector",
+ "operation": "Create Azure Databricks Access Connector",
+ "description": "Creates an Azure Databricks Access Connector."
+ }
+ },
+ {
+ "name": "Microsoft.Databricks/accessConnectors/delete",
+ "display": {
+ "provider": "Azure Databricks",
+ "resource": "AccessConnector",
+ "operation": "Remove Azure Databricks Access Connector",
+ "description": "Removes Azure Databricks Access Connector."
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OutboundNetworkDependenciesEndpointsList.json
new file mode 100644
index 000000000000..83793bbc9794
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/OutboundNetworkDependenciesEndpointsList.json
@@ -0,0 +1,120 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "category": "Webapp",
+ "endpoints": [
+ {
+ "endpointDetails": [
+ {
+ "ipAddress": "11.111.111.11/11",
+ "port": 123
+ },
+ {
+ "ipAddress": "22.222.222.22/22",
+ "port": 123
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "Control Plane NAT",
+ "endpoints": [
+ {
+ "endpointDetails": [
+ {
+ "ipAddress": "33.33.333.333/33",
+ "port": 123
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "Extended infrastructure",
+ "endpoints": [
+ {
+ "endpointDetails": [
+ {
+ "ipAddress": "44.44.44.44/44",
+ "port": 123
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "Azure Storage",
+ "endpoints": [
+ {
+ "domainName": "xxx.blob.core.windows.net",
+ "endpointDetails": [
+ {
+ "port": 123
+ }
+ ]
+ },
+ {
+ "domainName": "yyy.blob.core.windows.net",
+ "endpointDetails": [
+ {
+ "port": 123
+ }
+ ]
+ },
+ {
+ "domainName": "zzz.blob.core.windows.net",
+ "endpointDetails": [
+ {
+ "port": 123
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "Azure My SQL",
+ "endpoints": [
+ {
+ "domainName": "xxx.mysql.database.azure.com",
+ "endpointDetails": [
+ {
+ "port": 1234
+ }
+ ]
+ },
+ {
+ "domainName": "yyy.mysql.database.azure.com",
+ "endpointDetails": [
+ {
+ "port": 1234
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "Azure Servicebus",
+ "endpoints": [
+ {
+ "domainName": "xxx.servicebus.windows.net",
+ "endpointDetails": [
+ {
+ "port": 1234
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrepareEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrepareEncryption.json
new file mode 100644
index 000000000000..dfb27a272f93
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrepareEncryption.json
@@ -0,0 +1,100 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "prepareEncryption": {
+ "value": true
+ }
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "sku": {
+ "name": "premium"
+ },
+ "location": "East US 2",
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "storageAccountIdentity": {
+ "principalId": "55555555-5555-5555-5555-555555555555",
+ "tenantId": "66666666-6666-6666-6666-666666666666",
+ "type": "SystemAssigned"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsDelete.json
new file mode 100644
index 000000000000..e287dca35743
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsDelete.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationStatuses/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01",
+ "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsGet.json
new file mode 100644
index 000000000000..116da4ca6fb2
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsGet.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
+ "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Pending",
+ "description": "Please approve my request!",
+ "actionsRequired": "None"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsUpdate.json
new file mode 100644
index 000000000000..e51031b4f3a6
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateEndpointConnectionsUpdate.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "privateEndpointConnectionName": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "privateEndpointConnection": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by databricksadmin@contoso.com"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
+ "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by databricksadmin@contoso.com",
+ "actionsRequired": "None"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "body": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
+ "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "type": "Microsoft.Databricks/workspaces/PrivateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by databricksadmin@contoso.com",
+ "actionsRequired": "None"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateLinkResourcesGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateLinkResourcesGet.json
new file mode 100644
index 000000000000..c0916157e547
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/PrivateLinkResourcesGet.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "resourceGroupName": "myResourceGroup",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "groupId": "databricks_ui_api"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myResourceGroup/providers/Microsoft.Databricks/workspaces/myWorkspace/PrivateLinkResources/databricks_ui_api",
+ "name": "databricks_ui_api",
+ "type": "Microsoft.Databricks/workspaces/PrivateLinkResources",
+ "properties": {
+ "groupId": "databricks_ui_api",
+ "requiredMembers": [
+ "databricks_ui_api"
+ ],
+ "requiredZoneNames": [
+ "privatelink.azuredatabricks.net"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreate.json
new file mode 100644
index 000000000000..a721d7c0daa4
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreate.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG"
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreateWithParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreateWithParameters.json
new file mode 100644
index 000000000000..d783f3a74e42
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceCreateWithParameters.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "customVirtualNetworkId": {
+ "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
+ },
+ "customPublicSubnetName": {
+ "value": "myPublicSubnet"
+ },
+ "customPrivateSubnetName": {
+ "value": "myPrivateSubnet"
+ }
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "customPrivateSubnetName": {
+ "type": "String",
+ "value": "myPrivateSubnet"
+ },
+ "customPublicSubnetName": {
+ "type": "String",
+ "value": "myPublicSubnet"
+ },
+ "customVirtualNetworkId": {
+ "type": "String",
+ "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceDelete.json
new file mode 100644
index 000000000000..053498553226
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceDelete.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "workspaceName": "myWorkspace",
+ "resourceGroupName": "rg",
+ "api-version": "2023-02-01",
+ "subscriptionId": "subid"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01",
+ "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGet.json
new file mode 100644
index 000000000000..40d13ce1ed25
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGet.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "sku": {
+ "name": "premium"
+ },
+ "location": "East US 2",
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGetParameters.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGetParameters.json
new file mode 100644
index 000000000000..f471fbf8f0a0
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceGetParameters.json
@@ -0,0 +1,80 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": {
+ "customPrivateSubnetName": {
+ "type": "String",
+ "value": "PrivateBob"
+ },
+ "customPublicSubnetName": {
+ "type": "String",
+ "value": "PublicSarah"
+ },
+ "customVirtualNetworkId": {
+ "type": "String",
+ "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/subscriptionId/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace/privateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
+ "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
+ "type": "Microsoft.Databricks/workspaces/privateEndpointConnections",
+ "properties": {
+ "privateEndpoint": {
+ "id": "/subscriptions/subscriptionId/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ],
+ "publicNetworkAccess": "Disabled",
+ "requiredNsgRules": "NoAzureDatabricksRules"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionCreate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionCreate.json
new file mode 100644
index 000000000000..ee0ffb3128c7
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionCreate.json
@@ -0,0 +1,140 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ }
+ },
+ "location": "westus"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ },
+ "parameters": null,
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "managedDiskIdentity": {
+ "principalId": "22222222-2222-2222-2222-222222222222",
+ "tenantId": "44444444-4444-4444-4444-444444444444",
+ "type": "SystemAssigned"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "environment": "dev"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ },
+ "parameters": null,
+ "provisioningState": "Accepted",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "managedDiskIdentity": {
+ "principalId": "22222222-2222-2222-2222-222222222222",
+ "tenantId": "44444444-4444-4444-4444-444444444444",
+ "type": "SystemAssigned"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionGet.json
new file mode 100644
index 000000000000..03c76052dcba
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionGet.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "name": "myWorkspace",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "sku": {
+ "name": "premium"
+ },
+ "location": "East US 2",
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ },
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "managedDiskIdentity": {
+ "principalId": "22222222-2222-2222-2222-222222222222",
+ "tenantId": "44444444-4444-4444-4444-444444444444",
+ "type": "SystemAssigned"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionUpdate.json
new file mode 100644
index 000000000000..0dab277cf161
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceManagedDiskEncryptionUpdate.json
@@ -0,0 +1,148 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ }
+ },
+ "location": "westus",
+ "tags": {
+ "mytag1": "myvalue1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "mytag1": "myvalue1"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ },
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "managedDiskIdentity": {
+ "principalId": "22222222-2222-2222-2222-222222222222",
+ "tenantId": "44444444-4444-4444-4444-444444444444",
+ "type": "SystemAssigned"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "6666666666666666",
+ "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
+ }
+ }
+ },
+ "201": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "mytag1": "myvalue1"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "diskEncryptionSetId": "/subscriptions/subid/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
+ "encryption": {
+ "entities": {
+ "managedDisk": {
+ "keySource": "Microsoft.Keyvault",
+ "keyVaultProperties": {
+ "keyVaultUri": "https://test-vault-name.vault.azure.net/",
+ "keyName": "test-cmk-key",
+ "keyVersion": "00000000000000000000000000000000"
+ },
+ "rotationToLatestKeyVersionEnabled": true
+ }
+ }
+ },
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "managedDiskIdentity": {
+ "principalId": "22222222-2222-2222-2222-222222222222",
+ "tenantId": "44444444-4444-4444-4444-444444444444",
+ "type": "SystemAssigned"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "6666666666666666",
+ "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceUpdate.json
new file mode 100644
index 000000000000..e7a93c638815
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceUpdate.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01",
+ "parameters": {
+ "tags": {
+ "mytag1": "myvalue1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": {
+ "mytag1": "myvalue1"
+ },
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "6666666666666666",
+ "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01",
+ "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/HelloWorld/providers/Microsoft.Databricks/workspaces/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01"
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringGet.json
new file mode 100644
index 000000000000..4d0360e4a8c9
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringGet.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "peeringName": "vNetPeering",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
+ "name": "vNetPeeringTest",
+ "properties": {
+ "allowVirtualNetworkAccess": true,
+ "allowForwardedTraffic": false,
+ "allowGatewayTransit": false,
+ "useRemoteGateways": false,
+ "remoteVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
+ },
+ "remoteAddressSpace": {
+ "addressPrefixes": [
+ "10.203.0.0/16"
+ ]
+ },
+ "databricksVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
+ },
+ "databricksAddressSpace": {
+ "addressPrefixes": [
+ "10.139.0.0/16"
+ ]
+ },
+ "peeringState": "Initiated",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringList.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringList.json
new file mode 100644
index 000000000000..6059eae54d66
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetPeeringList.json
@@ -0,0 +1,45 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
+ "name": "vNetPeeringTest",
+ "properties": {
+ "allowVirtualNetworkAccess": true,
+ "allowForwardedTraffic": false,
+ "allowGatewayTransit": false,
+ "useRemoteGateways": false,
+ "remoteVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
+ },
+ "remoteAddressSpace": {
+ "addressPrefixes": [
+ "10.203.0.0/16"
+ ]
+ },
+ "databricksVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
+ },
+ "databricksAddressSpace": {
+ "addressPrefixes": [
+ "10.139.0.0/16"
+ ]
+ },
+ "peeringState": "Initiated",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json
new file mode 100644
index 000000000000..856ffb76fbad
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "peeringName": "vNetPeeringTest",
+ "api-version": "2023-02-01",
+ "VirtualNetworkPeeringParameters": {
+ "properties": {
+ "allowForwardedTraffic": false,
+ "allowGatewayTransit": false,
+ "allowVirtualNetworkAccess": true,
+ "remoteVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
+ },
+ "useRemoteGateways": false
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
+ "name": "vNetPeeringTest",
+ "properties": {
+ "allowVirtualNetworkAccess": true,
+ "allowForwardedTraffic": false,
+ "allowGatewayTransit": false,
+ "useRemoteGateways": false,
+ "remoteVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
+ },
+ "remoteAddressSpace": {
+ "addressPrefixes": [
+ "10.203.0.0/16"
+ ]
+ },
+ "databricksVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
+ },
+ "databricksAddressSpace": {
+ "addressPrefixes": [
+ "10.139.0.0/16"
+ ]
+ },
+ "peeringState": "Initiated",
+ "provisioningState": "Updating"
+ }
+ }
+ },
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest",
+ "name": "vNetPeeringTest",
+ "properties": {
+ "allowVirtualNetworkAccess": true,
+ "allowForwardedTraffic": false,
+ "allowGatewayTransit": false,
+ "useRemoteGateways": false,
+ "remoteVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet"
+ },
+ "remoteAddressSpace": {
+ "addressPrefixes": [
+ "10.203.0.0/16"
+ ]
+ },
+ "databricksVirtualNetwork": {
+ "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet"
+ },
+ "databricksAddressSpace": {
+ "addressPrefixes": [
+ "10.139.0.0/16"
+ ]
+ },
+ "peeringState": "Initiated",
+ "provisioningState": "Updating"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringDelete.json
new file mode 100644
index 000000000000..d2226c4cfcba
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspaceVirtualNetworkPeeringDelete.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "workspaceName": "myWorkspace",
+ "peeringName": "vNetPeering",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operations/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01",
+ "Location": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/providers/Microsoft.Network/locations/exampleLocation/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-02-01"
+ }
+ },
+ "204": {},
+ "200": {}
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListByResourceGroup.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListByResourceGroup.json
new file mode 100644
index 000000000000..842c67f8013a
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListByResourceGroup.json
@@ -0,0 +1,86 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "resourceGroupName": "rg",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "name": "myWorkspace1",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ },
+ {
+ "name": "myWorkspace2",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "6666666666666666",
+ "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListBySubscription.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListBySubscription.json
new file mode 100644
index 000000000000..2ae3430e3b75
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/examples/WorkspacesListBySubscription.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "subscriptionId": "subid",
+ "api-version": "2023-02-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "name": "myWorkspace1",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace1",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "premium"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "5555555555555555",
+ "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
+ }
+ },
+ {
+ "name": "myWorkspace2",
+ "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace2",
+ "type": "Microsoft.Databricks/workspaces",
+ "location": "East US 2",
+ "tags": null,
+ "sku": {
+ "name": "standard"
+ },
+ "properties": {
+ "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG",
+ "parameters": null,
+ "provisioningState": "Succeeded",
+ "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
+ "authorizations": [
+ {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
+ }
+ ],
+ "createdBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "updatedBy": {
+ "oid": "22222222-2222-2222-2222-222222222222",
+ "puid": "33333333",
+ "applicationId": "44444444-4444-4444-4444-444444444444"
+ },
+ "createdDateTime": "2020-02-20T00:10:29.2858439Z",
+ "workspaceId": "6666666666666666",
+ "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/vnetpeering.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/vnetpeering.json
new file mode 100644
index 000000000000..ba28f1e657a7
--- /dev/null
+++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2023-02-01/vnetpeering.json
@@ -0,0 +1,490 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "DatabricksClient",
+ "version": "2023-02-01",
+ "description": "ARM Databricks"
+ },
+ "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.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": {
+ "get": {
+ "tags": [
+ "vNetPeering"
+ ],
+ "operationId": "vNetPeering_Get",
+ "description": "Gets the workspace vNet Peering.",
+ "x-ms-examples": {
+ "Get a workspace with vNet Peering Configured": {
+ "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PeeringNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/VirtualNetworkPeering"
+ }
+ },
+ "204": {
+ "description": "OK - NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "vNetPeering"
+ ],
+ "operationId": "vNetPeering_Delete",
+ "description": "Deletes the workspace vNetPeering.",
+ "x-ms-examples": {
+ "Delete a workspace vNet Peering": {
+ "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PeeringNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "200": {
+ "description": "OK. The request has succeeded."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "vNetPeering"
+ ],
+ "operationId": "vNetPeering_CreateOrUpdate",
+ "description": "Creates vNet Peering for workspace.",
+ "x-ms-examples": {
+ "Create vNet Peering for Workspace": {
+ "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "VirtualNetworkPeeringParameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VirtualNetworkPeering"
+ },
+ "description": "Parameters supplied to the create workspace vNet Peering."
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/PeeringNameParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created - Returns information about the workspace vNet peering, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/VirtualNetworkPeering"
+ }
+ },
+ "200": {
+ "description": "Update succeeded - Returns information about the workspace vNet peering.",
+ "schema": {
+ "$ref": "#/definitions/VirtualNetworkPeering"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": {
+ "get": {
+ "tags": [
+ "vNetPeering"
+ ],
+ "operationId": "vNetPeering_ListByWorkspace",
+ "description": "Lists the workspace vNet Peerings.",
+ "x-ms-examples": {
+ "List all vNet Peerings for the workspace": {
+ "$ref": "./examples/WorkspaceVirtualNetPeeringList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/WorkspaceName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List succeeded. Returns the resulting resource objects in response body.",
+ "schema": {
+ "$ref": "#/definitions/VirtualNetworkPeeringList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ErrorDetail": {
+ "title": "Error details.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The error's code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A human readable error message.",
+ "type": "string"
+ },
+ "target": {
+ "description": "Indicates which property in the request is responsible for the error.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "ErrorInfo": {
+ "title": "The code and message for an error.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "A machine readable error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A human readable error message.",
+ "type": "string"
+ },
+ "details": {
+ "description": "error details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorDetail"
+ }
+ },
+ "innererror": {
+ "description": "Inner error details if they exist.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "ErrorResponse": {
+ "title": "Error response.",
+ "description": "Contains details when the response code indicates an error.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error details.",
+ "$ref": "#/definitions/ErrorInfo"
+ }
+ },
+ "required": [
+ "error"
+ ]
+ },
+ "VirtualNetworkPeeringList": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualNetworkPeering"
+ },
+ "description": "List of virtual network peerings on workspace."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of virtual network peering list results if there are any."
+ }
+ },
+ "description": "Gets all virtual network peerings under a workspace."
+ },
+ "VirtualNetworkPeering": {
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat",
+ "description": "List of properties for vNet Peering"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the virtual network peering resource",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "Resource ID.",
+ "readOnly": true
+ },
+ "type": {
+ "type": "string",
+ "description": "type of the virtual network peering resource",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Peerings in a VirtualNetwork resource",
+ "x-ms-azure-resource": true
+ },
+ "VirtualNetworkPeeringPropertiesFormat": {
+ "properties": {
+ "allowVirtualNetworkAccess": {
+ "type": "boolean",
+ "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space."
+ },
+ "allowForwardedTraffic": {
+ "type": "boolean",
+ "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network."
+ },
+ "allowGatewayTransit": {
+ "type": "boolean",
+ "description": "If gateway links can be used in remote virtual networking to link to this virtual network."
+ },
+ "useRemoteGateways": {
+ "type": "boolean",
+ "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway."
+ },
+ "databricksVirtualNetwork": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The Id of the databricks virtual network."
+ }
+ },
+ "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)."
+ },
+ "databricksAddressSpace": {
+ "$ref": "#/definitions/AddressSpace",
+ "description": "The reference to the databricks virtual network address space."
+ },
+ "remoteVirtualNetwork": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The Id of the remote virtual network."
+ }
+ },
+ "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)."
+ },
+ "remoteAddressSpace": {
+ "$ref": "#/definitions/AddressSpace",
+ "description": "The reference to the remote virtual network address space."
+ },
+ "peeringState": {
+ "type": "string",
+ "description": "The status of the virtual network peering.",
+ "enum": [
+ "Initiated",
+ "Connected",
+ "Disconnected"
+ ],
+ "x-ms-enum": {
+ "name": "peeringState",
+ "modelAsString": true
+ },
+ "readOnly": true
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "$ref": "#/definitions/PeeringProvisioningState",
+ "description": "The provisioning state of the virtual network peering resource."
+ }
+ },
+ "required": [
+ "remoteVirtualNetwork"
+ ],
+ "description": "Properties of the virtual network peering."
+ },
+ "PeeringProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Updating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PeeringProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "AddressSpace": {
+ "properties": {
+ "addressPrefixes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of address blocks reserved for this virtual network in CIDR notation."
+ }
+ },
+ "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation."
+ },
+ "ResourceGroupName": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "WorkspaceName": {
+ "name": "workspaceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the workspace.",
+ "minLength": 3,
+ "maxLength": 64,
+ "x-ms-parameter-location": "method"
+ },
+ "PeeringNameParameter": {
+ "name": "peeringName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the workspace vNet peering.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md
index 54743dcf821f..a8edea87b9d6 100644
--- a/specification/databricks/resource-manager/readme.md
+++ b/specification/databricks/resource-manager/readme.md
@@ -12,10 +12,25 @@ This is the AutoRest configuration file for Databricks.
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2023-02-01
- tag: package-2022-04-01-preview
- tag: package-2021-04-01-preview
- tag: package-2018-04-01
```
+
+### Tag: package-2023-02-01 and java
+
+These settings apply only when `--tag=package-2023-02-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2023-02-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.databricks.v2023_02_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/databricks/mgmt-v2023_02_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2022-04-01-preview and java
These settings apply only when `--tag=package-2022-04-01-preview --java` is specified on the command line.
@@ -75,9 +90,9 @@ These are the global settings for the Databricks API.
``` yaml
title: AzureDatabricksManagementClient
-description: 'The Microsoft Azure management APIs allow end users to operate on Azure Databricks Workspace resources.'
+description: 'The Microsoft Azure management APIs allow end users to operate on Azure Databricks Workspace / Access Connector resources.'
openapi-type: arm
-tag: package-2022-04-01-preview
+tag: package-2023-02-01
```
### Tag: package-2018-04-01
@@ -111,6 +126,17 @@ input-file:
- Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json
```
+### Tag: package-2023-02-01
+
+These settings apply only when `--tag=package-2023-02-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2023-02-01'
+input-file:
+- Microsoft.Databricks/stable/2023-02-01/databricks.json
+- Microsoft.Databricks/stable/2023-02-01/vnetpeering.json
+- Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json
+```
+
---
# Suppressions
diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json
index 88fe64434559..842d396958ec 100644
--- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json
+++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json
@@ -126,6 +126,14 @@
"vNetProperties": {
"description": "VNet properties for managed integration runtime.",
"$ref": "#/definitions/IntegrationRuntimeVNetProperties"
+ },
+ "copyComputeScaleProperties": {
+ "description": "CopyComputeScale properties for managed integration runtime.",
+ "$ref": "#/definitions/CopyComputeScaleProperties"
+ },
+ "pipelineExternalComputeScaleProperties": {
+ "description": "PipelineExternalComputeScale properties for managed integration runtime.",
+ "$ref": "#/definitions/PipelineExternalComputeScaleProperties"
}
},
"additionalProperties": {
@@ -167,6 +175,42 @@
"type": "object"
}
},
+ "CopyComputeScaleProperties": {
+ "description": "CopyComputeScale properties for managed integration runtime.",
+ "type": "object",
+ "properties": {
+ "dataIntegrationUnit": {
+ "description": "DIU number setting reserved for copy activity execution. Supported values are multiples of 4 in range 4-256.",
+ "type": "integer",
+ "format": "int32",
+ "minimum": 4
+ },
+ "timeToLive": {
+ "description": "Time to live (in minutes) setting of integration runtime which will execute copy activity.",
+ "type": "integer",
+ "format": "int32",
+ "minimum": 5
+ }
+ },
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
+ "PipelineExternalComputeScaleProperties": {
+ "description": "PipelineExternalComputeScale properties for managed integration runtime.",
+ "type": "object",
+ "properties": {
+ "timeToLive": {
+ "description": "Time to live (in minutes) setting of integration runtime which will execute pipeline and external activity.",
+ "type": "integer",
+ "format": "int32",
+ "minimum": 5
+ }
+ },
+ "additionalProperties": {
+ "type": "object"
+ }
+ },
"IntegrationRuntimeVNetProperties": {
"description": "VNet properties for managed integration runtime.",
"type": "object",
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 ef0f3a4a5dbc..632baf75bf9a 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
@@ -191,6 +191,25 @@
"credential": {
"$ref": "../datafactory.json#/definitions/CredentialReference",
"description": "The credential reference containing authentication information."
+ },
+ "authenticationType": {
+ "x-ms-enum": {
+ "name": "AzureStorageAuthenticationType",
+ "modelAsString": true
+ },
+ "enum": [
+ "Anonymous",
+ "AccountKey",
+ "SasUri",
+ "ServicePrincipal",
+ "Msi"
+ ],
+ "type": "string",
+ "description": "The type used for authentication. Type: string."
+ },
+ "containerUri": {
+ "type": "object",
+ "description": "Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string)."
}
}
},
diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json
index aa195fbdbcc4..2a7ea9b6083f 100644
--- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json
+++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json
@@ -7931,6 +7931,10 @@
"type": "object",
"description": "The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string)."
},
+ "scanFolder": {
+ "type": "object",
+ "description": "Scanning subfolders from the root folder of the main definition file, these files will be added as reference files. The folders named 'jars', 'pyFiles', 'files' or 'archives' will be scanned, and the folders name are case sensitive. Type: boolean (or Expression with resultType boolean)."
+ },
"className": {
"type": "object",
"description": "The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string)."
@@ -7979,9 +7983,33 @@
"description": "Number of core and memory to be used for driver allocated in the specified Spark pool for the job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string)."
},
"numExecutors": {
- "description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.",
- "type": "integer",
- "format": "int32"
+ "description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide. Type: integer (or Expression with resultType integer).",
+ "type": "object"
+ },
+ "configurationType": {
+ "enum": [
+ "Default",
+ "Customized",
+ "Artifact"
+ ],
+ "type": "string",
+ "description": "The type of the spark config.",
+ "x-ms-enum": {
+ "name": "ConfigurationType",
+ "modelAsString": true
+ }
+ },
+ "targetSparkConfiguration": {
+ "description": "The spark configuration of the spark job.",
+ "$ref": "#/definitions/SparkConfigurationParametrizationReference"
+ },
+ "sparkConfig": {
+ "description": "Spark configuration property.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "description": "Type: string (or Expression with resultType string)."
+ }
}
},
"required": [
@@ -8012,6 +8040,31 @@
"type",
"referenceName"
]
+ },
+ "SparkConfigurationParametrizationReference": {
+ "description": "Spark configuration reference.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Spark configuration reference type.",
+ "type": "string",
+ "enum": [
+ "SparkConfigurationReference"
+ ],
+ "x-ms-enum": {
+ "name": "SparkConfigurationReferenceType",
+ "modelAsString": true
+ }
+ },
+ "referenceName": {
+ "description": "Reference spark configuration name. Type: string (or Expression with resultType string).",
+ "type": "object"
+ }
+ },
+ "required": [
+ "type",
+ "referenceName"
+ ]
}
}
}
diff --git a/specification/datamigration/resource-manager/readme.java.md b/specification/datamigration/resource-manager/readme.java.md
index da62571f4061..f5aa5905e7ad 100644
--- a/specification/datamigration/resource-manager/readme.java.md
+++ b/specification/datamigration/resource-manager/readme.java.md
@@ -1,61 +1,27 @@
## Java
These settings apply only when `--java` is specified on the command line.
-Please also specify `--azure-libraries-for-java-folder=`.
``` yaml $(java)
-azure-arm: true
-fluent: true
-namespace: com.microsoft.azure.management.datamigration
-license-header: MICROSOFT_MIT_NO_CODEGEN
-payload-flattening-threshold: 1
-output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datamigration
-```
-
-### Java multi-api
-
-``` yaml $(java) && $(multiapi)
-batch:
- - tag: package-2018-07-15-preview
- - tag: package-2017-11-15-preview
- - tag: package-2018-03-31-preview
-```
-
-### Tag: package-2018-07-15-preview and java
-
-These settings apply only when `--tag=package-2018-07-15-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2018-07-15-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.datamigration.v2018_07_15_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/datamigration/mgmt-v2018_07_15_preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2017-11-15-preview and java
-
-These settings apply only when `--tag=package-2017-11-15-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2017-11-15-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.datamigration.v2017_11_15_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/datamigration/mgmt-v2017_11_15_preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2018-03-31-preview and java
-
-These settings apply only when `--tag=package-2018-03-31-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2018-03-31-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.datamigration.v2018_03_31_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/datamigration/mgmt-v2018_03_31_preview
-regenerate-manager: true
-generate-interface: true
+directive:
+ - from: swagger-document
+ where: $.definitions.MigrateMySqlAzureDbForMySqlSyncTaskOutput
+ transform: >
+ $['required'] = ['resultType'];
+ - from: swagger-document
+ where: $.definitions.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput
+ transform: >
+ $['required'] = ['resultType'];
+ - from: swagger-document
+ where: $.definitions.MigrateSqlServerSqlDbSyncTaskOutput
+ transform: >
+ $['required'] = ['resultType'];
+ - from: swagger-document
+ where: $.definitions.MigrateSqlServerSqlMITaskOutput
+ transform: >
+ $['required'] = ['resultType'];
+ - from: swagger-document
+ where: $.definitions.MigrateSqlServerSqlMISyncTaskOutput
+ transform: >
+ $['required'] = ['resultType'];
```
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/dataprotection.json
new file mode 100644
index 000000000000..fb8bfab0d7a0
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/dataprotection.json
@@ -0,0 +1,7460 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-11-01-preview",
+ "title": "DataProtectionBackupClient",
+ "x-ms-code-generation-settings": {
+ "internalConstructors": false
+ }
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a subscription.",
+ "operationId": "BackupVaults_GetInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in Subscription": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "GetOperationResult"
+ ],
+ "description": "Gets the operation result for a resource",
+ "operationId": "OperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets the operation status for a resource.",
+ "x-ms-examples": {
+ "Get OperationResult": {
+ "$ref": "./examples/GetOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for a resource.",
+ "operationId": "OperationStatus_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatus.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a BackupVault's context.",
+ "operationId": "OperationStatusBackupVaultContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusVaultContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a ResourceGroup's context.",
+ "operationId": "OperationStatusResourceGroupContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusRGContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a resource group.",
+ "operationId": "BackupVaults_GetInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in ResourceGroup": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns a resource belonging to a resource group.",
+ "operationId": "BackupVaults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupVault": {
+ "$ref": "./examples/VaultCRUD/GetBackupVault.json"
+ },
+ "Get BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Creates or updates a BackupVault resource belonging to a resource group.",
+ "operationId": "BackupVaults_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupVault": {
+ "$ref": "./examples/VaultCRUD/PutBackupVault.json"
+ },
+ "Create BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Deletes a BackupVault resource from the resource group.",
+ "operationId": "BackupVaults_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupVault": {
+ "$ref": "./examples/VaultCRUD/DeleteBackupVault.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "BackupVaults_Update",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceRequestInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Patch BackupVault": {
+ "$ref": "./examples/VaultCRUD/PatchBackupVault.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "BackupVaultOperationResults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetOperationResult Patch": {
+ "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "summary": "API to check for resource name availability",
+ "operationId": "BackupVaults_CheckNameAvailability",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "The location in which uniqueness will be verified.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Check name availability request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check BackupVaults name availability": {
+ "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": {
+ "post": {
+ "tags": [
+ "DppFeatureSupport"
+ ],
+ "summary": "Validates if a feature is supported",
+ "operationId": "DataProtection_CheckFeatureSupport",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Feature support request object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check Azure Vm Backup Feature Support": {
+ "$ref": "./examples/CheckfeatureSupport.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.DataProtection/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Returns the list of available operations.",
+ "operationId": "DataProtectionOperations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClientDiscoveryResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "value"
+ },
+ "x-ms-examples": {
+ "Returns the list of supported REST operations.": {
+ "$ref": "./examples/Operations/List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "description": "Returns list of backup policies belonging to a backup vault",
+ "operationId": "BackupPolicies_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Get",
+ "description": "Gets a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets a backup policy belonging to a backup vault",
+ "x-ms-examples": {
+ "Get BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_CreateOrUpdate",
+ "summary": "Creates or Updates a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "description": "Name of the policy",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CreateOrUpdate BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Delete",
+ "summary": "Deletes a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instances belonging to a backup vault",
+ "operationId": "BackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupInstances in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/{resourceId}/providers/Microsoft.DataProtection/backupInstances": {
+ "get": {
+ "tags": [
+ "BackupInstancesExtensionRouting"
+ ],
+ "description": "Gets a list backup instances associated with a tracked resource",
+ "operationId": "BackupInstancesExtensionRouting_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupInstances associated with an azure resource": {
+ "$ref": "./examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instance with name in a backup vault",
+ "operationId": "BackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Create or update a backup instance in a backup vault",
+ "operationId": "BackupInstances_CreateOrUpdate",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Delete a backup instance in a backup vault",
+ "operationId": "BackupInstances_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "200": {
+ "description": "Ok"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Trigger adhoc backup ",
+ "operationId": "BackupInstances_AdhocBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Trigger Adhoc Backup": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validate whether adhoc backup will be successful or not",
+ "operationId": "BackupInstances_ValidateForBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateForBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Validate For Backup": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Get result of backup instance creation operation",
+ "operationId": "BackupInstances_GetBackupInstanceOperationResult",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstanceOperationResult": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Returns a list of Recovery Points for a DataSource in a vault.",
+ "operationId": "RecoveryPoints_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "OData filter options.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "skipToken Filter.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/RecoveryPointsFilters",
+ "x-ms-examples": {
+ "List Recovery Points in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Gets a Recovery Point using recoveryPointId for a Datasource.",
+ "operationId": "RecoveryPoints_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "recoveryPointId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Recovery Point": {
+ "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": {
+ "post": {
+ "description": "rehydrate recovery point for restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRehydrate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "description": "Request body for operation",
+ "in": "body",
+ "name": "parameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRehydrationRequest"
+ }
+ },
+ {
+ "in": "path",
+ "name": "backupInstanceName",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "tags": [
+ "BackupInstances"
+ ],
+ "x-ms-examples": {
+ "Trigger Rehydrate": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Triggers restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Trigger Restore": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json"
+ },
+ "Trigger Restore As Files": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json"
+ },
+ "Trigger Restore With Rehydration": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume backups for backup instance",
+ "operationId": "BackupInstances_ResumeBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeBackups": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume protection for a stopped backup instance",
+ "operationId": "BackupInstances_ResumeProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeProtection": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop protection of a backup instance and data will be held forever",
+ "operationId": "BackupInstances_StopProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StopProtection": {
+ "$ref": "./examples/BackupInstanceOperations/StopProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)",
+ "operationId": "BackupInstances_SuspendBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SuspendBackups": {
+ "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state",
+ "operationId": "BackupInstances_SyncBackupInstance",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncBackupInstanceRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Sync BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validates if Restore can be triggered for a DataSource",
+ "operationId": "BackupInstances_ValidateForRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateRestoreRequestObject"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Validate Restore": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": {
+ "get": {
+ "tags": [
+ "AzureBackupJobs"
+ ],
+ "description": "Returns list of jobs belonging to a backup vault",
+ "operationId": "Jobs_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get Jobs": {
+ "$ref": "./examples/JobCRUD/ListJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": {
+ "post": {
+ "tags": [
+ "FindRestorableTimeRanges"
+ ],
+ "operationId": "RestorableTimeRanges_Find",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Find Restorable Time Ranges": {
+ "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets a job with id in a backup vault",
+ "operationId": "Jobs_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "jobId",
+ "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Job": {
+ "$ref": "./examples/JobCRUD/GetJob.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": {
+ "post": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Triggers export of jobs and returns an OperationID to track.",
+ "operationId": "ExportJobs_Trigger",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Trigger Export Jobs": {
+ "$ref": "./examples/JobCRUD/TriggerExportJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.",
+ "operationId": "ExportJobsOperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "description": "OperationID which represents the export job.",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExportJobsResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Export Jobs Operation Result": {
+ "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets deleted backup instances belonging to a backup vault",
+ "operationId": "DeletedBackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List DeletedBackupInstances in a Vault": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets a deleted backup instance with name in a backup vault",
+ "operationId": "DeletedBackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DeletedBackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete": {
+ "post": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "operationId": "DeletedBackupInstances_Undelete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Undelete Deleted BackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a subscription.",
+ "operationId": "ResourceGuards_GetResourcesInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in Subscription": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a ResourceGroup.",
+ "operationId": "ResourceGuards_GetResourcesInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in ResourceGroup": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}": {
+ "put": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Creates or updates a ResourceGuard resource belonging to a resource group.",
+ "operationId": "ResourceGuards_Put",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PutResourceGuard.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns a ResourceGuard belonging to a resource group.",
+ "operationId": "ResourceGuards_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuard.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Deletes a ResourceGuard resource from the resource group.",
+ "operationId": "ResourceGuards_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/DeleteResourceGuard.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "ResourceGuards_Patch",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceRequestInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PatchResourceGuard.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDisableSoftDeleteRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetBackupSecurityPINRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies": {
+ "get": {
+ "tags": [
+ "DppResourceGuardProxies"
+ ],
+ "operationId": "DppResourceGuardProxy_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardProxyBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuardProxies": {
+ "$ref": "./examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}": {
+ "get": {
+ "tags": [
+ "DppResourceGuardProxies"
+ ],
+ "operationId": "DppResourceGuardProxy_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "resourceGuardProxyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardProxyBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceGuardProxy": {
+ "$ref": "./examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "DppResourceGuardProxies"
+ ],
+ "operationId": "DppResourceGuardProxy_Put",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "resourceGuardProxyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardProxyBaseResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardProxyBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create ResourceGuardProxy": {
+ "$ref": "./examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DppResourceGuardProxies"
+ ],
+ "operationId": "DppResourceGuardProxy_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "resourceGuardProxyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete ResourceGuardProxy": {
+ "$ref": "./examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete": {
+ "post": {
+ "tags": [
+ "DppResourceGuardProxies"
+ ],
+ "operationId": "DppResourceGuardProxy_UnlockDelete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionId"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupName"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "resourceGuardProxyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/ApiVersion"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/UnlockDeleteRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UnlockDeleteResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "UnlockDelete ResourceGuardProxy": {
+ "$ref": "./examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AbsoluteDeleteOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeleteOption"
+ }
+ ],
+ "description": "Delete option with duration",
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "AbsoluteDeleteOption",
+ "type": "object",
+ "x-ms-discriminator-value": "AbsoluteDeleteOption"
+ },
+ "RecoveryPointsFilters": {
+ "type": "object",
+ "properties": {
+ "restorePointDataStoreId": {
+ "type": "string"
+ },
+ "isVisible": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "extendedInfo": {
+ "type": "boolean"
+ },
+ "restorePointState": {
+ "type": "string"
+ }
+ }
+ },
+ "AdHocBackupRuleOptions": {
+ "description": "Adhoc backup rules",
+ "properties": {
+ "ruleName": {
+ "type": "string"
+ },
+ "triggerOption": {
+ "$ref": "#/definitions/AdhocBackupTriggerOption"
+ }
+ },
+ "required": [
+ "ruleName",
+ "triggerOption"
+ ],
+ "title": "AdHocBackupRuleOptions",
+ "type": "object"
+ },
+ "AdhocBackupTriggerOption": {
+ "description": "Adhoc backup trigger option",
+ "properties": {
+ "retentionTagOverride": {
+ "type": "string"
+ }
+ },
+ "title": "AdhocBackupTriggerOption",
+ "type": "object"
+ },
+ "AdhocBasedTaggingCriteria": {
+ "description": "Adhoc backup tagging criteria",
+ "properties": {
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "title": "AdhocBasedTaggingCriteria",
+ "type": "object"
+ },
+ "AdhocBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Adhoc trigger context",
+ "properties": {
+ "taggingCriteria": {
+ "$ref": "#/definitions/AdhocBasedTaggingCriteria",
+ "description": "Tagging Criteria containing retention tag for adhoc backup."
+ }
+ },
+ "required": [
+ "objectType",
+ "taggingCriteria"
+ ],
+ "title": "AdhocBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "AdhocBasedTriggerContext"
+ },
+ "AuthCredentials": {
+ "description": "Base class for different types of authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "AzureBackupDiscreteRecoveryPoint": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint"
+ }
+ ],
+ "description": "Azure backup discrete RecoveryPoint",
+ "properties": {
+ "friendlyName": {
+ "type": "string"
+ },
+ "recoveryPointDataStoresDetails": {
+ "items": {
+ "$ref": "#/definitions/RecoveryPointDataStoreDetails"
+ },
+ "type": "array"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "policyName": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "type": "string"
+ },
+ "recoveryPointId": {
+ "type": "string"
+ },
+ "recoveryPointType": {
+ "type": "string"
+ },
+ "retentionTagName": {
+ "type": "string"
+ },
+ "retentionTagVersion": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupDiscreteRecoveryPoint",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint"
+ },
+ "AzureBackupFindRestorableTimeRangesRequest": {
+ "description": "List Restore Ranges Request",
+ "required": [
+ "sourceDataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreSourceDataStoreType",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "description": "Start time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesRequestResource": {
+ "description": "List Restore Ranges Request",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppWorkerRequest"
+ }
+ ],
+ "properties": {
+ "content": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest",
+ "description": "AzureBackupFindRestorableTimeRangesRequestResource content"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponse": {
+ "description": "List Restore Ranges Response",
+ "type": "object",
+ "properties": {
+ "restorableTimeRanges": {
+ "description": "Returns the Restore Ranges available on the Backup Instance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RestorableTimeRange"
+ },
+ "x-ms-identifiers": []
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponseResource": {
+ "description": "List Restore Ranges Response",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse",
+ "description": "AzureBackupFindRestorableTimeRangesResponseResource properties"
+ }
+ }
+ },
+ "AzureBackupJob": {
+ "description": "AzureBackup Job Class",
+ "properties": {
+ "activityID": {
+ "description": "Job Activity Id",
+ "type": "string"
+ },
+ "backupInstanceFriendlyName": {
+ "description": "Name of the Backup Instance",
+ "type": "string"
+ },
+ "backupInstanceId": {
+ "description": "ARM ID of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "ARM ID of the DataSource",
+ "type": "string"
+ },
+ "dataSourceLocation": {
+ "description": "Location of the DataSource",
+ "type": "string"
+ },
+ "dataSourceName": {
+ "description": "User Friendly Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceSetName": {
+ "description": "Data Source Set Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceType": {
+ "description": "Type of DataSource",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Total run time of the job. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "EndTime of the job(in UTC)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "A List, detailing the errors related to the job",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "extendedInfo": {
+ "$ref": "#/definitions/JobExtendedInfo",
+ "description": "Extended Information about the job",
+ "readOnly": true
+ },
+ "isUserTriggered": {
+ "description": "Indicated that whether the job is adhoc(true) or scheduled(false)",
+ "type": "boolean"
+ },
+ "operation": {
+ "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure",
+ "type": "string"
+ },
+ "operationCategory": {
+ "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management",
+ "type": "string"
+ },
+ "policyId": {
+ "description": "ARM ID of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyName": {
+ "description": "Name of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "progressEnabled": {
+ "description": "Indicated whether progress is enabled for the job",
+ "type": "boolean"
+ },
+ "progressUrl": {
+ "description": "Url which contains job's progress",
+ "readOnly": true,
+ "type": "string"
+ },
+ "restoreType": {
+ "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceResourceGroup": {
+ "description": "Resource Group Name of the Datasource",
+ "type": "string"
+ },
+ "sourceSubscriptionID": {
+ "description": "SubscriptionId corresponding to the DataSource",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "StartTime of the job(in UTC)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning",
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "Subscription Id of the corresponding backup vault",
+ "type": "string"
+ },
+ "supportedActions": {
+ "description": "List of supported actions",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vaultName": {
+ "description": "Name of the vault",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "sourceDataStoreName": {
+ "type": "string"
+ },
+ "destinationDataStoreName": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "activityID",
+ "subscriptionId",
+ "dataSourceId",
+ "vaultName",
+ "backupInstanceFriendlyName",
+ "sourceResourceGroup",
+ "dataSourceName",
+ "progressEnabled",
+ "sourceSubscriptionID",
+ "dataSourceLocation",
+ "startTime",
+ "dataSourceType",
+ "operationCategory",
+ "operation",
+ "status",
+ "isUserTriggered",
+ "supportedActions"
+ ],
+ "type": "object"
+ },
+ "AzureBackupJobResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "AzureBackup Job Resource Class",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupJob",
+ "description": "AzureBackupJobResource properties",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupJobResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of AzureBackup Job resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupParams": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupParameters"
+ }
+ ],
+ "description": "Azure backup parameters",
+ "properties": {
+ "backupType": {
+ "description": "BackupType ; Full/Incremental etc",
+ "type": "string"
+ }
+ },
+ "required": [
+ "backupType",
+ "objectType"
+ ],
+ "title": "AzureBackupParams",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupParams"
+ },
+ "AzureBackupRecoveryPoint": {
+ "description": "Azure backup recoveryPoint",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "AzureBackupRecoveryPoint",
+ "type": "object"
+ },
+ "AzureBackupRecoveryPointBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "Azure backup recoveryPoint based restore request",
+ "properties": {
+ "recoveryPointId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId"
+ ],
+ "title": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest"
+ },
+ "AzureBackupRecoveryPointResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint",
+ "description": "AzureBackupRecoveryPointResource properties"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResource"
+ },
+ "AzureBackupRecoveryPointResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource list",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResourceList",
+ "type": "object"
+ },
+ "AzureBackupRehydrationRequest": {
+ "description": "Azure Backup Rehydrate Request",
+ "properties": {
+ "recoveryPointId": {
+ "description": "Id of the recovery point to be recovered",
+ "type": "string"
+ },
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRehydrationRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreRequest": {
+ "description": "Azure backup restore request",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ },
+ "restoreTargetInfo": {
+ "$ref": "#/definitions/RestoreTargetInfoBase",
+ "description": "Gets or sets the restore target information."
+ },
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "ArchiveStore",
+ "SnapshotStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "SourceDataStoreType"
+ }
+ },
+ "sourceResourceId": {
+ "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "restoreTargetInfo",
+ "sourceDataStoreType"
+ ],
+ "title": "AzureBackupRestoreRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreWithRehydrationRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup Restore with Rehydration Request",
+ "properties": {
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "rehydrationPriority",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRestoreWithRehydrationRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest"
+ },
+ "AzureBackupRecoveryTimeBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup RecoveryPointTime Based Restore Request",
+ "properties": {
+ "recoveryPointTime": {
+ "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupRecoveryTimeBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest"
+ },
+ "AzureBackupRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure backup rule",
+ "properties": {
+ "backupParameters": {
+ "$ref": "#/definitions/BackupParameters"
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "trigger": {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ },
+ "required": [
+ "dataStore",
+ "name",
+ "objectType",
+ "trigger"
+ ],
+ "title": "AzureBackupRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRule"
+ },
+ "AzureMonitorAlertSettings": {
+ "type": "object",
+ "description": "Settings for Azure Monitor based alerts",
+ "properties": {
+ "alertsForAllJobFailures": {
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AlertsState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AzureOperationalStoreParameters": {
+ "description": "Parameters for Operational-Tier DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataStoreParameters"
+ }
+ ],
+ "properties": {
+ "resourceGroupId": {
+ "description": "Gets or sets the Snapshot Resource Group Uri.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "AzureOperationalStoreParameters"
+ },
+ "KubernetesClusterBackupDatasourceParameters": {
+ "description": "Parameters for Kubernetes Cluster Backup Datasource",
+ "required": [
+ "snapshotVolumes",
+ "includeClusterScopeResources"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ }
+ ],
+ "properties": {
+ "snapshotVolumes": {
+ "description": "Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during restore.",
+ "type": "boolean"
+ },
+ "includeClusterScopeResources": {
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.",
+ "type": "boolean"
+ },
+ "includedNamespaces": {
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedNamespaces": {
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedResourceTypes": {
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedResourceTypes": {
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "labelSelectors": {
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesClusterBackupDatasourceParameters"
+ },
+ "BlobBackupDatasourceParameters": {
+ "description": "Parameters to be used during configuration of backup of blobs",
+ "required": [
+ "containersList",
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ }
+ ],
+ "properties": {
+ "containersList": {
+ "description": "List of containers to be backed up during configuration of backup of blobs",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "BlobBackupDatasourceParameters"
+ },
+ "AzureRetentionRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure retention rule",
+ "properties": {
+ "isDefault": {
+ "type": "boolean"
+ },
+ "lifecycles": {
+ "items": {
+ "$ref": "#/definitions/SourceLifeCycle"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "lifecycles",
+ "name",
+ "objectType"
+ ],
+ "title": "AzureRetentionRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureRetentionRule"
+ },
+ "BackupCriteria": {
+ "description": "BackupCriteria base class",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupCriteria",
+ "type": "object"
+ },
+ "BackupInstance": {
+ "description": "Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo",
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "friendlyName": {
+ "description": "Gets or sets the Backup Instance friendly name.",
+ "type": "string"
+ },
+ "dataSourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Gets or sets the data source information."
+ },
+ "dataSourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Gets or sets the data source set information."
+ },
+ "policyInfo": {
+ "$ref": "#/definitions/PolicyInfo",
+ "description": "Gets or sets the policy information."
+ },
+ "protectionStatus": {
+ "$ref": "#/definitions/ProtectionStatusDetails",
+ "description": "Specifies the protection status of the resource",
+ "readOnly": true
+ },
+ "currentProtectionState": {
+ "description": "Specifies the current protection state of the resource",
+ "enum": [
+ "Invalid",
+ "NotProtected",
+ "ConfiguringProtection",
+ "ProtectionConfigured",
+ "BackupSchedulesSuspended",
+ "RetentionSchedulesSuspended",
+ "ProtectionStopped",
+ "ProtectionError",
+ "ConfiguringProtectionFailed",
+ "SoftDeleting",
+ "SoftDeleted",
+ "UpdatingProtection"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CurrentProtectionState",
+ "modelAsString": true
+ }
+ },
+ "protectionErrorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection error of the resource",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed",
+ "type": "string",
+ "readOnly": true
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "validationType": {
+ "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.",
+ "enum": [
+ "ShallowValidation",
+ "DeepValidation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationType",
+ "modelAsString": true
+ }
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "BackupInstanceResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppProxyResource"
+ }
+ ],
+ "description": "BackupInstance Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupInstance",
+ "description": "BackupInstanceResource properties"
+ }
+ },
+ "title": "BackupInstanceResource"
+ },
+ "BackupInstanceResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "BackupInstance Resource list response",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupInstanceResourceList",
+ "type": "object"
+ },
+ "BackupParameters": {
+ "description": "BackupParameters base",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupParameters",
+ "type": "object"
+ },
+ "BackupPolicy": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BaseBackupPolicy"
+ }
+ ],
+ "description": "Rule based backup policy",
+ "properties": {
+ "policyRules": {
+ "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc",
+ "items": {
+ "$ref": "#/definitions/BasePolicyRule"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "policyRules"
+ ],
+ "title": "BackupPolicy",
+ "type": "object",
+ "x-ms-discriminator-value": "BackupPolicy"
+ },
+ "BackupSchedule": {
+ "description": "Schedule for backup",
+ "properties": {
+ "repeatingTimeIntervals": {
+ "description": "ISO 8601 repeating time interval format",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "timeZone": {
+ "description": "Time zone for a schedule. Example: Pacific Standard Time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "repeatingTimeIntervals"
+ ],
+ "title": "BackupSchedule",
+ "type": "object"
+ },
+ "BackupVault": {
+ "description": "Backup Vault",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "ProvisioningState"
+ }
+ },
+ "resourceMoveState": {
+ "description": "Resource move state for backup vault",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "PrepareFailed",
+ "CommitFailed",
+ "Failed",
+ "PrepareTimedout",
+ "CommitTimedout",
+ "CriticalFailure",
+ "PartialSuccess",
+ "MoveSucceeded"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ResourceMoveState",
+ "modelAsString": true
+ }
+ },
+ "resourceMoveDetails": {
+ "$ref": "#/definitions/ResourceMoveDetails",
+ "description": "Resource move details for backup vault",
+ "readOnly": true
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ },
+ "storageSettings": {
+ "description": "Storage Settings",
+ "items": {
+ "$ref": "#/definitions/StorageSetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isVaultProtectedByResourceGuard": {
+ "description": "Is vault protected by resource guard",
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "storageSettings"
+ ],
+ "title": "BackupVault",
+ "type": "object"
+ },
+ "BackupVaultResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResource"
+ }
+ ],
+ "description": "Backup Vault Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupVault",
+ "description": "BackupVaultResource properties"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "title": "BackupVault Resource"
+ },
+ "BackupVaultResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BackupVault resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupVaultResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupVaultResourceList",
+ "type": "object"
+ },
+ "BaseBackupPolicy": {
+ "description": "BackupPolicy base",
+ "discriminator": "objectType",
+ "properties": {
+ "datasourceTypes": {
+ "description": "Type of datasource for the backup management",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "objectType"
+ ],
+ "title": "BaseBackupPolicy",
+ "type": "object"
+ },
+ "BaseBackupPolicyResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "BaseBackupPolicy resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BaseBackupPolicy",
+ "description": "BaseBackupPolicyResource properties"
+ }
+ },
+ "title": "BaseBackupPolicyResource"
+ },
+ "BaseBackupPolicyResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BaseBackupPolicy resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BaseBackupPolicyResourceList",
+ "type": "object"
+ },
+ "BasePolicyRule": {
+ "description": "BasePolicy Rule",
+ "discriminator": "objectType",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "objectType"
+ ],
+ "title": "BasePolicyRule",
+ "type": "object"
+ },
+ "CheckNameAvailabilityRequest": {
+ "description": "CheckNameAvailability Request",
+ "properties": {
+ "name": {
+ "description": "Resource name for which availability needs to be checked",
+ "type": "string"
+ },
+ "type": {
+ "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityRequest",
+ "type": "object"
+ },
+ "CheckNameAvailabilityResult": {
+ "description": "CheckNameAvailability Result",
+ "properties": {
+ "message": {
+ "description": "Gets or sets the message.",
+ "type": "string"
+ },
+ "nameAvailable": {
+ "description": "Gets or sets a value indicating whether [name available].",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "Gets or sets the reason.",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityResult",
+ "type": "object"
+ },
+ "ClientDiscoveryDisplay": {
+ "description": "Localized display information of an operation.",
+ "properties": {
+ "description": {
+ "description": "Description of the operation having details of what operation is about.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operations Name itself.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Name of the provider for display purposes",
+ "type": "string"
+ },
+ "resource": {
+ "description": "ResourceType for which this Operation can be performed.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryDisplay",
+ "type": "object"
+ },
+ "ClientDiscoveryForLogSpecification": {
+ "description": "Class to represent shoebox log specification in json client discovery.",
+ "properties": {
+ "blobDuration": {
+ "description": "blob duration of shoebox log specification",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name for shoebox log specification.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryForLogSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryForProperties": {
+ "description": "Class to represent shoebox properties in json client discovery.",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ClientDiscoveryForServiceSpecification",
+ "description": "Operation properties."
+ }
+ },
+ "title": "ClientDiscoveryForProperties",
+ "type": "object"
+ },
+ "ClientDiscoveryForServiceSpecification": {
+ "description": "Class to represent shoebox service specification in json client discovery.",
+ "properties": {
+ "logSpecifications": {
+ "description": "List of log specifications of this operation.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryForLogSpecification"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryForServiceSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryResponse": {
+ "description": "Operations List response which contains list of available APIs.",
+ "properties": {
+ "nextLink": {
+ "description": "Link to the next chunk of Response.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of available operations.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryValueForSingleApi"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryResponse",
+ "type": "object"
+ },
+ "ClientDiscoveryValueForSingleApi": {
+ "description": "Available operation details.",
+ "properties": {
+ "display": {
+ "$ref": "#/definitions/ClientDiscoveryDisplay",
+ "description": "Contains the localized display information for this particular operation"
+ },
+ "name": {
+ "description": "Name of the Operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ },
+ "origin": {
+ "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/ClientDiscoveryForProperties",
+ "description": "Properties for the given operation."
+ }
+ },
+ "title": "ClientDiscoveryValueForSingleApi",
+ "type": "object"
+ },
+ "CloudError": {
+ "description": "An error response from Azure Backup.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "title": "CloudError",
+ "x-ms-external": true
+ },
+ "CopyOnExpiryOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Copy on Expiry Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOnExpiryOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CopyOnExpiryOption"
+ },
+ "CopyOption": {
+ "description": "Options to copy",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOption",
+ "type": "object"
+ },
+ "CustomCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Duration based custom options to copy",
+ "properties": {
+ "duration": {
+ "description": "Data copied after given timespan",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CustomCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CustomCopyOption"
+ },
+ "Datasource": {
+ "description": "Datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "Datasource",
+ "type": "object"
+ },
+ "DatasourceSet": {
+ "description": "DatasourceSet details of datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "DatasourceSet",
+ "type": "object"
+ },
+ "DataStoreInfoBase": {
+ "description": "DataStoreInfo base",
+ "properties": {
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DataStoreTypes"
+ }
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "readOnly": false,
+ "type": "string"
+ }
+ },
+ "required": [
+ "dataStoreType",
+ "objectType"
+ ],
+ "title": "DataStoreInfoBase",
+ "type": "object"
+ },
+ "DataStoreParameters": {
+ "description": "Parameters for DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ },
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataStoreTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "BackupDatasourceParameters": {
+ "description": "Parameters for Backup Datasource",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "Day": {
+ "description": "Day of the week",
+ "properties": {
+ "date": {
+ "description": "Date of the month",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isLast": {
+ "description": "Whether Date is last date of month",
+ "type": "boolean"
+ }
+ },
+ "title": "Day",
+ "type": "object"
+ },
+ "DeletedBackupInstance": {
+ "description": "Deleted Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ ],
+ "properties": {
+ "deletionInfo": {
+ "$ref": "#/definitions/DeletionInfo",
+ "description": "Deletion info of Backup Instance",
+ "readOnly": true
+ }
+ }
+ },
+ "DeletedBackupInstanceResource": {
+ "description": "Deleted Backup Instance",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeletedBackupInstance",
+ "description": "DeletedBackupInstanceResource properties"
+ }
+ }
+ },
+ "DeletedBackupInstanceResourceList": {
+ "description": "List of DeletedBackupInstance resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ }
+ }
+ },
+ "DeletionInfo": {
+ "description": "Deletion Info",
+ "type": "object",
+ "properties": {
+ "deletionTime": {
+ "description": "Specifies time of deletion",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingEndDate": {
+ "description": "Specifies billing end date",
+ "type": "string",
+ "readOnly": true
+ },
+ "scheduledPurgeTime": {
+ "description": "Specifies purge time",
+ "type": "string",
+ "readOnly": true
+ },
+ "deleteActivityID": {
+ "description": "Delete activity ID for troubleshooting purpose",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DeleteOption": {
+ "description": "Delete Option",
+ "discriminator": "objectType",
+ "properties": {
+ "duration": {
+ "description": "Duration of deletion after given timespan",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "DeleteOption",
+ "type": "object"
+ },
+ "DppIdentityDetails": {
+ "description": "Identity details",
+ "properties": {
+ "principalId": {
+ "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "The identityType which can be either SystemAssigned or None",
+ "type": "string"
+ }
+ },
+ "title": "DppIdentityDetails",
+ "type": "object"
+ },
+ "DppBaseResourceList": {
+ "description": "Base for all lists of V2 resources.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Dpp resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "DppBaseResource": {
+ "type": "object",
+ "description": "Base resource under Microsoft.DataProtection provider namespace",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DppResource": {
+ "description": "Resource class",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "title": "DppResource",
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppResourceList": {
+ "description": "ListResource",
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "title": "List Resource",
+ "type": "object"
+ },
+ "DppTrackedResource": {
+ "properties": {
+ "eTag": {
+ "description": "Optional ETag.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "ImmutabilitySettings": {
+ "description": "Immutability Settings at vault level",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "Immutability state",
+ "enum": [
+ "Disabled",
+ "Unlocked",
+ "Locked"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImmutabilityState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DppProxyResource": {
+ "properties": {
+ "id": {
+ "description": "Proxy Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Proxy Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Proxy Resource tags.",
+ "type": "object"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "systemData": {
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "createdBy": {
+ "type": "string",
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": "string",
+ "description": "The type of identity that created the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": "string",
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": "string",
+ "description": "The type of identity that last modified the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "lastModifiedAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The type of identity that last modified the resource."
+ }
+ }
+ },
+ "DppTrackedResourceList": {
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DppWorkerRequest": {
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ },
+ "headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "supportedGroupVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cultureInfo": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "httpMethod": {
+ "type": "string"
+ }
+ }
+ },
+ "Error": {
+ "description": "The resource management error response.",
+ "properties": {
+ "additionalInfo": {
+ "description": "The error additional info.",
+ "items": {
+ "$ref": "#/definitions/ErrorAdditionalInfo"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "code": {
+ "description": "The error code.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "details": {
+ "description": "The error details.",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "message": {
+ "description": "The error message.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "target": {
+ "description": "The error target.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ErrorAdditionalInfo": {
+ "description": "The resource management error additional info.",
+ "properties": {
+ "info": {
+ "description": "The additional info.",
+ "readOnly": true,
+ "type": "object"
+ },
+ "type": {
+ "description": "The additional info type.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ExportJobsResult": {
+ "description": "The result for export jobs containing blob details.",
+ "properties": {
+ "blobUrl": {
+ "description": "URL of the blob into which the serialized string of list of jobs is exported.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "blobSasKey": {
+ "description": "SAS key to access the blob.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobUrl": {
+ "description": "URL of the blob into which the ExcelFile is uploaded.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobSasKey": {
+ "description": "SAS key to access the ExcelFile blob.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "title": "ExportJobsResult",
+ "type": "object"
+ },
+ "FeatureValidationRequest": {
+ "description": "Base class for feature object",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "featureName": {
+ "description": "backup support feature name.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationRequest"
+ },
+ "FeatureValidationRequestBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "FeatureValidationResponse": {
+ "description": "Feature Validation Response",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "features": {
+ "description": "Response features",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SupportedFeature"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationResponse"
+ },
+ "FeatureValidationResponseBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ImmediateCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Immediate copy Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "ImmediateCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "ImmediateCopyOption"
+ },
+ "InnerError": {
+ "description": "Inner Error",
+ "properties": {
+ "additionalInfo": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Any Key value pairs that can be provided to the client for additional verbose information.",
+ "type": "object"
+ },
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "embeddedInnerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Child Inner Error, to allow Nesting."
+ }
+ },
+ "title": "InnerError",
+ "type": "object"
+ },
+ "ItemLevelRestoreCriteria": {
+ "description": "Class to contain criteria for item level restore",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ItemLevelRestoreTargetInfo": {
+ "description": "Restore target info for Item level restore operation",
+ "required": [
+ "restoreCriteria",
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "properties": {
+ "restoreCriteria": {
+ "description": "Restore Criteria",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ },
+ "x-ms-identifiers": []
+ },
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo"
+ },
+ "ItemPathBasedRestoreCriteria": {
+ "description": "Prefix criteria to be used to during restore",
+ "required": [
+ "itemPath",
+ "isPathRelativeToBackupItem",
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "itemPath": {
+ "description": "The path of the item to be restored. It could be the full path of the item or the path relative to the backup item",
+ "type": "string"
+ },
+ "isPathRelativeToBackupItem": {
+ "description": "Flag to specify if the path is relative to backup item or full path",
+ "type": "boolean"
+ },
+ "subItemPathPrefix": {
+ "description": "The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ItemPathBasedRestoreCriteria"
+ },
+ "JobExtendedInfo": {
+ "description": "Extended Information about the job",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Job's Additional Details"
+ },
+ "backupInstanceState": {
+ "description": "State of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataTransferredInBytes": {
+ "description": "Number of bytes transferred",
+ "format": "double",
+ "readOnly": true,
+ "type": "number"
+ },
+ "recoveryDestination": {
+ "description": "Destination where restore is done",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Source Recovery Point",
+ "readOnly": true
+ },
+ "subTasks": {
+ "description": "List of Sub Tasks of the job",
+ "items": {
+ "$ref": "#/definitions/JobSubTask"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "targetRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Target Recovery Point",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "JobSubTask": {
+ "description": "Details of Job's Sub Task",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Additional details of Sub Tasks"
+ },
+ "taskId": {
+ "description": "Task Id of the Sub Task",
+ "format": "int32",
+ "type": "integer"
+ },
+ "taskName": {
+ "description": "Name of the Sub Task",
+ "type": "string"
+ },
+ "taskProgress": {
+ "description": "Progress of the Sub Task",
+ "readOnly": true,
+ "type": "string"
+ },
+ "taskStatus": {
+ "description": "Status of the Sub Task",
+ "type": "string"
+ }
+ },
+ "required": [
+ "taskId",
+ "taskName",
+ "taskStatus"
+ ],
+ "type": "object"
+ },
+ "MonitoringSettings": {
+ "type": "object",
+ "description": "Monitoring Settings",
+ "properties": {
+ "azureMonitorAlertSettings": {
+ "$ref": "#/definitions/AzureMonitorAlertSettings"
+ }
+ }
+ },
+ "OperationExtendedInfo": {
+ "description": "Operation Extended Info",
+ "properties": {
+ "objectType": {
+ "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.",
+ "type": "string"
+ }
+ },
+ "title": "OperationExtendedInfo",
+ "discriminator": "objectType",
+ "type": "object",
+ "required": [
+ "objectType"
+ ]
+ },
+ "OperationJobExtendedInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/OperationExtendedInfo"
+ }
+ ],
+ "description": "Operation Job Extended Info",
+ "properties": {
+ "jobId": {
+ "description": "Arm Id of the job created for this operation.",
+ "type": "string"
+ }
+ },
+ "title": "OperationJobExtendedInfo",
+ "type": "object",
+ "x-ms-discriminator-value": "OperationJobExtendedInfo"
+ },
+ "OperationResource": {
+ "description": "Operation Resource",
+ "properties": {
+ "endTime": {
+ "description": "End time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
+ },
+ "id": {
+ "description": "It should match what is used to GET the operation result",
+ "type": "string"
+ },
+ "name": {
+ "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationExtendedInfo",
+ "description": "End time of the operation"
+ },
+ "startTime": {
+ "description": "Start time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "title": "OperationResource",
+ "type": "object"
+ },
+ "PatchBackupVaultInput": {
+ "description": "Backup Vault Contract for Patch Backup Vault API.",
+ "type": "object",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ }
+ }
+ },
+ "PatchResourceRequestInput": {
+ "description": "Patch Request content for Microsoft.DataProtection resources",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ },
+ "properties": {
+ "$ref": "#/definitions/PatchBackupVaultInput",
+ "description": "Resource properties."
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ }
+ },
+ "title": "PatchResourceRequestInput",
+ "type": "object"
+ },
+ "PolicyInfo": {
+ "description": "Policy Info in backupInstance",
+ "properties": {
+ "policyId": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyParameters": {
+ "$ref": "#/definitions/PolicyParameters",
+ "description": "Policy parameters for the backup instance"
+ }
+ },
+ "required": [
+ "policyId"
+ ],
+ "title": "PolicyInfo",
+ "type": "object"
+ },
+ "PolicyParameters": {
+ "description": "Parameters in Policy",
+ "type": "object",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ],
+ "properties": {
+ "dataStoreParametersList": {
+ "description": "Gets or sets the DataStore Parameters",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataStoreParameters"
+ },
+ "x-ms-identifiers": []
+ },
+ "backupDatasourceParametersList": {
+ "description": "Gets or sets the Backup Data Source Parameters",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ProtectionStatusDetails": {
+ "description": "Protection status details",
+ "properties": {
+ "errorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection status error of the resource"
+ },
+ "status": {
+ "description": "Specifies the protection status of the resource",
+ "enum": [
+ "ConfiguringProtection",
+ "ConfiguringProtectionFailed",
+ "ProtectionConfigured",
+ "ProtectionStopped",
+ "SoftDeleted",
+ "SoftDeleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Status"
+ }
+ }
+ },
+ "title": "ProtectionStatusDetails",
+ "type": "object"
+ },
+ "RangeBasedItemLevelRestoreCriteria": {
+ "description": "Item Level target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "minMatchingValue": {
+ "description": "minimum value for range prefix match",
+ "type": "string"
+ },
+ "maxMatchingValue": {
+ "description": "maximum value for range prefix match",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria"
+ },
+ "KubernetesStorageClassRestoreCriteria": {
+ "description": "Item Level kubernetes storage class target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "selectedStorageClassName": {
+ "description": "Selected storage class name",
+ "type": "string"
+ },
+ "provisioner": {
+ "description": "Provisioner of the storage class",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesStorageClassRestoreCriteria"
+ },
+ "KubernetesPVRestoreCriteria": {
+ "description": "Item Level kubernetes persistent volume target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "name": {
+ "description": "Selected persistent volume claim name",
+ "type": "string"
+ },
+ "storageClassName": {
+ "description": "Selected storage class name for restore operation",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesPVRestoreCriteria"
+ },
+ "KubernetesClusterRestoreCriteria": {
+ "description": "kubernetes Cluster Backup target info for restore operation",
+ "required": [
+ "includeClusterScopeResources"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "includeClusterScopeResources": {
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.",
+ "type": "boolean"
+ },
+ "includedNamespaces": {
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedNamespaces": {
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedResourceTypes": {
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedResourceTypes": {
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "labelSelectors": {
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "persistentVolumeRestoreMode": {
+ "description": "Gets or sets the PV Restore Mode property. This property sets whether volumes needs to be restored.",
+ "enum": [
+ "RestoreWithVolumeData",
+ "RestoreWithoutVolumeData"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PersistentVolumeRestoreMode",
+ "modelAsString": true
+ }
+ },
+ "conflictPolicy": {
+ "description": "Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.",
+ "enum": [
+ "Skip",
+ "Patch"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ExistingResourcePolicy",
+ "modelAsString": true
+ }
+ },
+ "namespaceMappings": {
+ "description": "Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesClusterRestoreCriteria"
+ },
+ "RecoveryPointDataStoreDetails": {
+ "description": "RecoveryPoint datastore details",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "expiryTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "metaData": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "visible": {
+ "type": "boolean"
+ },
+ "rehydrationExpiryTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ },
+ "rehydrationStatus": {
+ "readOnly": true,
+ "enum": [
+ "CREATE_IN_PROGRESS",
+ "COMPLETED",
+ "DELETE_IN_PROGRESS",
+ "DELETED",
+ "FAILED"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationStatus"
+ }
+ }
+ },
+ "title": "RecoveryPointDataStoreDetails",
+ "type": "object"
+ },
+ "RehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "enum": [
+ "Invalid",
+ "High",
+ "Standard"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationPriority"
+ }
+ },
+ "RestoreFilesTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore as files target parameters",
+ "properties": {
+ "targetDetails": {
+ "$ref": "#/definitions/TargetDetails",
+ "description": "Destination of RestoreAsFiles operation, when destination is not a datasource"
+ }
+ },
+ "required": [
+ "recoveryOption",
+ "targetDetails"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreFilesTargetInfo"
+ },
+ "RestoreJobRecoveryPointDetails": {
+ "properties": {
+ "recoveryPointID": {
+ "type": "string"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RestoreTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore target parameters",
+ "properties": {
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "required": [
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreTargetInfo"
+ },
+ "RestoreTargetInfoBase": {
+ "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "recoveryOption": {
+ "description": "Recovery Option",
+ "enum": [
+ "FailIfExists"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RecoveryOption"
+ }
+ },
+ "restoreLocation": {
+ "description": "Target Restore region",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "recoveryOption"
+ ],
+ "type": "object"
+ },
+ "ResourceMoveDetails": {
+ "description": "ResourceMoveDetails will be returned in response to GetResource call from ARM",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "CorrelationId of latest ResourceMove operation attempted",
+ "type": "string"
+ },
+ "startTimeUtc": {
+ "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "completionTimeUtc": {
+ "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "sourceResourcePath": {
+ "description": "ARM resource path of source resource",
+ "type": "string"
+ },
+ "targetResourcePath": {
+ "description": "ARM resource path of target resource used in latest ResourceMove operation",
+ "type": "string"
+ }
+ }
+ },
+ "RestorableTimeRange": {
+ "required": [
+ "startTime",
+ "endTime"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "Start time for the available restore range",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the available restore range",
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "RetentionTag": {
+ "description": "Retention tag",
+ "properties": {
+ "eTag": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Retention Tag Name to relate it to retention rule.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "tagName"
+ ],
+ "title": "RetentionTag",
+ "type": "object"
+ },
+ "ScheduleBasedBackupCriteria": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupCriteria"
+ }
+ ],
+ "description": "Schedule based backup criteria",
+ "properties": {
+ "absoluteCriteria": {
+ "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum",
+ "items": {
+ "enum": [
+ "AllBackup",
+ "FirstOfDay",
+ "FirstOfMonth",
+ "FirstOfWeek",
+ "FirstOfYear"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "AbsoluteMarker"
+ }
+ },
+ "type": "array"
+ },
+ "daysOfMonth": {
+ "description": "This is day of the month from 1 to 28 other wise last of month",
+ "items": {
+ "$ref": "#/definitions/Day"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "daysOfTheWeek": {
+ "description": "It should be Sunday/Monday/T..../Saturday",
+ "items": {
+ "enum": [
+ "Friday",
+ "Monday",
+ "Saturday",
+ "Sunday",
+ "Thursday",
+ "Tuesday",
+ "Wednesday"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DayOfWeek"
+ }
+ },
+ "type": "array"
+ },
+ "monthsOfYear": {
+ "description": "It should be January/February/....../December",
+ "items": {
+ "enum": [
+ "April",
+ "August",
+ "December",
+ "February",
+ "January",
+ "July",
+ "June",
+ "March",
+ "May",
+ "November",
+ "October",
+ "September"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Month"
+ }
+ },
+ "type": "array"
+ },
+ "scheduleTimes": {
+ "description": "List of schedule times for backup",
+ "items": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "weeksOfTheMonth": {
+ "description": "It should be First/Second/Third/Fourth/Last",
+ "items": {
+ "enum": [
+ "First",
+ "Fourth",
+ "Last",
+ "Second",
+ "Third"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "WeekNumber"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "ScheduleBasedBackupCriteria",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedBackupCriteria"
+ },
+ "ScheduleBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Schedule based trigger context",
+ "properties": {
+ "schedule": {
+ "$ref": "#/definitions/BackupSchedule",
+ "description": "Schedule for this backup"
+ },
+ "taggingCriteria": {
+ "description": "List of tags that can be applicable for given schedule.",
+ "items": {
+ "$ref": "#/definitions/TaggingCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType",
+ "schedule",
+ "taggingCriteria"
+ ],
+ "title": "ScheduleBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedTriggerContext"
+ },
+ "SecretStoreBasedAuthCredentials": {
+ "description": "Secret store based authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AuthCredentials"
+ }
+ ],
+ "properties": {
+ "secretStoreResource": {
+ "$ref": "#/definitions/SecretStoreResource",
+ "description": "Secret store resource"
+ }
+ },
+ "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials"
+ },
+ "SecretStoreResource": {
+ "description": "Class representing a secret store resource.",
+ "required": [
+ "secretStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "uri": {
+ "description": "Uri to get to the resource",
+ "type": "string"
+ },
+ "secretStoreType": {
+ "description": "Gets or sets the type of secret store",
+ "enum": [
+ "Invalid",
+ "AzureKeyVault"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SecretStoreType",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "Gets or sets value stored in secret store resource",
+ "type": "string"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "Class containing security settings of vault",
+ "type": "object",
+ "properties": {
+ "softDeleteSettings": {
+ "$ref": "#/definitions/SoftDeleteSettings"
+ },
+ "immutabilitySettings": {
+ "$ref": "#/definitions/ImmutabilitySettings"
+ }
+ }
+ },
+ "SoftDeleteSettings": {
+ "description": "Soft delete related settings",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "State of soft delete",
+ "enum": [
+ "Off",
+ "On",
+ "AlwaysOn"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SoftDeleteState",
+ "modelAsString": true,
+ "values": [
+ {
+ "description": "Soft Delete is turned off for the BackupVault",
+ "value": "Off"
+ },
+ {
+ "description": "Soft Delete is enabled for the BackupVault but can be turned off",
+ "value": "On"
+ },
+ {
+ "description": "Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed",
+ "value": "AlwaysOn"
+ }
+ ]
+ }
+ },
+ "retentionDurationInDays": {
+ "description": "Soft delete retention duration",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "SourceLifeCycle": {
+ "description": "Source LifeCycle",
+ "properties": {
+ "deleteAfter": {
+ "$ref": "#/definitions/DeleteOption"
+ },
+ "sourceDataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "targetDataStoreCopySettings": {
+ "items": {
+ "$ref": "#/definitions/TargetCopySetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "deleteAfter",
+ "sourceDataStore"
+ ],
+ "title": "SourceLifeCycle",
+ "type": "object"
+ },
+ "StorageSetting": {
+ "description": "Storage setting",
+ "properties": {
+ "datastoreType": {
+ "description": "Gets or sets the type of the datastore.",
+ "enum": [
+ "ArchiveStore",
+ "SnapshotStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingStoreTypes"
+ }
+ },
+ "type": {
+ "description": "Gets or sets the type.",
+ "enum": [
+ "GeoRedundant",
+ "LocallyRedundant",
+ "ZoneRedundant"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingTypes"
+ }
+ }
+ },
+ "title": "StorageSetting",
+ "type": "object"
+ },
+ "SupportedFeature": {
+ "description": "Elements class for feature request",
+ "type": "object",
+ "properties": {
+ "featureName": {
+ "description": "support feature type.",
+ "type": "string"
+ },
+ "supportStatus": {
+ "description": "feature support status",
+ "enum": [
+ "Invalid",
+ "NotSupported",
+ "AlphaPreview",
+ "PrivatePreview",
+ "PublicPreview",
+ "GenerallyAvailable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureSupportStatus",
+ "modelAsString": true
+ }
+ },
+ "exposureControlledFeatures": {
+ "description": "support feature type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SyncBackupInstanceRequest": {
+ "description": "Sync BackupInstance Request",
+ "type": "object",
+ "properties": {
+ "syncType": {
+ "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases",
+ "enum": [
+ "Default",
+ "ForceResync"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TaggingCriteria": {
+ "description": "Tagging criteria",
+ "properties": {
+ "criteria": {
+ "description": "Criteria which decides whether the tag can be applied to a triggered backup.",
+ "items": {
+ "$ref": "#/definitions/BackupCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isDefault": {
+ "description": "Specifies if tag is default.",
+ "type": "boolean"
+ },
+ "taggingPriority": {
+ "description": "Retention Tag priority.",
+ "format": "int64",
+ "type": "integer"
+ },
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "required": [
+ "isDefault",
+ "tagInfo",
+ "taggingPriority"
+ ],
+ "title": "TaggingCriteria",
+ "type": "object"
+ },
+ "TargetCopySetting": {
+ "description": "Target copy settings",
+ "properties": {
+ "copyAfter": {
+ "$ref": "#/definitions/CopyOption",
+ "description": "It can be CustomCopyOption or ImmediateCopyOption."
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase",
+ "description": "Info of target datastore"
+ }
+ },
+ "required": [
+ "copyAfter",
+ "dataStore"
+ ],
+ "title": "TargetCopySetting",
+ "type": "object"
+ },
+ "TargetDetails": {
+ "description": "Class encapsulating target details, used where the destination is not a datasource",
+ "properties": {
+ "filePrefix": {
+ "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them",
+ "type": "string"
+ },
+ "restoreTargetLocationType": {
+ "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}",
+ "enum": [
+ "Invalid",
+ "AzureBlobs",
+ "AzureFiles"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreTargetLocationType",
+ "modelAsString": true
+ }
+ },
+ "url": {
+ "description": "Url denoting the restore destination. It can point to container / file share etc",
+ "type": "string"
+ }
+ },
+ "required": [
+ "filePrefix",
+ "restoreTargetLocationType",
+ "url"
+ ],
+ "type": "object"
+ },
+ "TriggerBackupRequest": {
+ "description": "Trigger backup request",
+ "properties": {
+ "backupRuleOptions": {
+ "$ref": "#/definitions/AdHocBackupRuleOptions",
+ "description": "Name for the Rule of the Policy which needs to be applied for this backup"
+ }
+ },
+ "required": [
+ "backupRuleOptions"
+ ],
+ "title": "TriggerBackupRequest",
+ "type": "object"
+ },
+ "TriggerContext": {
+ "description": "Trigger context",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "TriggerContext",
+ "type": "object"
+ },
+ "UserFacingError": {
+ "description": "Error object used by layers that have access to localized content, and propagate that to user",
+ "properties": {
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "details": {
+ "description": "Additional related Errors",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "innerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Inner Error"
+ },
+ "isRetryable": {
+ "description": "Whether the operation will be retryable or not",
+ "type": "boolean"
+ },
+ "isUserError": {
+ "description": "Whether the operation is due to a user error or service error",
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Any key value pairs that can be injected inside error object",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "recommendedAction": {
+ "description": "RecommendedAction � localized.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "target": {
+ "description": "Target of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ValidateForBackupRequest": {
+ "description": "Validate for backup request",
+ "properties": {
+ "backupInstance": {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ },
+ "required": [
+ "backupInstance"
+ ],
+ "title": "ValidateForBackupRequest",
+ "type": "object"
+ },
+ "ValidateRestoreRequestObject": {
+ "description": "Validate restore request object",
+ "properties": {
+ "restoreRequestObject": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest",
+ "description": "Gets or sets the restore request object."
+ }
+ },
+ "required": [
+ "restoreRequestObject"
+ ],
+ "title": "ValidateRestoreRequestObject",
+ "type": "object"
+ },
+ "ResourceGuard": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ResourceGuardProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "allowAutoApprovals": {
+ "description": "This flag indicates whether auto approval is allowed or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "resourceGuardOperations": {
+ "description": "{readonly} List of operation details those are protected by the ResourceGuard resource",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardOperation"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "vaultCriticalOperationExclusionList": {
+ "description": "List of critical operations which are not protected by this resourceGuard",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Description about the pre-req steps to perform all the critical operations.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardOperation": {
+ "description": "This class contains all the details about a critical operation.",
+ "type": "object",
+ "properties": {
+ "vaultCriticalOperation": {
+ "description": "Name of the critical operation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requestResourceType": {
+ "description": "Type of resource request.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResource"
+ }
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ResourceGuard",
+ "description": "ResourceGuardResource properties"
+ }
+ }
+ },
+ "ResourceGuardResourceList": {
+ "description": "List of ResourceGuard resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ }
+ },
+ "ResourceGuardOperationDetail": {
+ "type": "object",
+ "properties": {
+ "vaultCriticalOperation": {
+ "type": "string"
+ },
+ "defaultResourceRequest": {
+ "type": "string"
+ }
+ }
+ },
+ "ResourceGuardProxyBase": {
+ "type": "object",
+ "properties": {
+ "resourceGuardResourceId": {
+ "type": "string"
+ },
+ "resourceGuardOperationDetails": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardOperationDetail"
+ },
+ "x-ms-identifiers": []
+ },
+ "lastUpdatedTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "ResourceGuardProxyBaseResource": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ResourceGuardProxyBase",
+ "description": "ResourceGuardProxyBaseResource properties"
+ }
+ }
+ },
+ "ResourceGuardProxyBaseResourceList": {
+ "description": "List of ResourceGuardProxyBase resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardProxyBaseResource"
+ }
+ }
+ }
+ },
+ "UnlockDeleteRequest": {
+ "description": "Request body of unlock delete API.",
+ "type": "object",
+ "properties": {
+ "resourceGuardOperationRequests": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "resourceToBeDeleted": {
+ "type": "string"
+ }
+ }
+ },
+ "UnlockDeleteResponse": {
+ "description": "Response of Unlock Delete API.",
+ "type": "object",
+ "properties": {
+ "unlockDeleteExpiryTime": {
+ "description": "This is the time when unlock delete privileges will get expired.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionId": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription Id.",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceGroupName": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group where the backup vault is present.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "VaultName": {
+ "name": "vaultName",
+ "in": "path",
+ "description": "The name of the backup vault.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersion": {
+ "name": "api-version",
+ "in": "query",
+ "description": "Client Api Version.",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceId": {
+ "name": "resourceId",
+ "in": "path",
+ "description": "ARM path of the resource to be protected using Microsoft.DataProtection",
+ "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."
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json
new file mode 100644
index 000000000000..1da9cb405133
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "backupInstanceName": "testInstance1",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "204": {},
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
new file mode 100644
index 000000000000..d43a1105dd70
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "Blob-Backup",
+ "vaultName": "ZBlobBackupVaultBVTD3",
+ "backupInstanceName": "zblobbackuptestsa58",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "sourceDataStoreType": "OperationalStore",
+ "startTime": "2020-10-17T23:28:17.6829685Z",
+ "endTime": "2021-02-24T00:35:17.6829685Z"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "zblobbackuptestsa58",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges",
+ "properties": {
+ "restorableTimeRanges": [
+ {
+ "startTime": "2021-02-23T18:33:51.6349708Z",
+ "endTime": "2021-02-24T00:35:17.0000000Z",
+ "objectType": "RestorableTimeRange"
+ }
+ ],
+ "objectType": "AzureBackupFindRestorableTimeRangesResponse"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json
new file mode 100644
index 000000000000..0a84264dd03e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
new file mode 100644
index 000000000000..34cb4cde9180
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "backupInstanceName": "testInstance1",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "ConfiguringProtection"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json
new file mode 100644
index 000000000000..3f8b6212e8e9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json
new file mode 100644
index 000000000000..265c2b1569a0
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json
new file mode 100644
index 000000000000..19889fd4e547
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json
@@ -0,0 +1,59 @@
+{
+ "parameters": {
+ "resourceId": "subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "friendlyName": "testDisk",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk",
+ "resourceUri": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk",
+ "datasourceType": "Microsoft.Compute/disks",
+ "resourceName": "testDisk",
+ "resourceType": "Microsoft.Compute/disks",
+ "resourceLocation": "eastus2euap",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk",
+ "resourceUri": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk",
+ "datasourceType": "Microsoft.Compute/disks",
+ "resourceName": "testDisk",
+ "resourceType": "Microsoft.Compute/disks",
+ "resourceLocation": "eastus2euap",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG/providers/Microsoft.DataProtection/backupVaults/jeczrsecy/backupPolicies/disk",
+ "policyVersion": "",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "ProtectionConfigured"
+ },
+ "currentProtectionState": "ProtectionConfigured",
+ "provisioningState": "Succeeded",
+ "objectType": "BackupInstance"
+ },
+ "id": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk/providers/Microsoft.DataProtection/backupInstances/testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3",
+ "name": "testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json
new file mode 100644
index 000000000000..b66f1384ac6d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json
new file mode 100644
index 000000000000..3299a5bfd0a6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json
@@ -0,0 +1,167 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "validationType": "ShallowValidation"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ },
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeBackups.json
new file mode 100644
index 000000000000..3fd8ecfc3268
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeProtection.json
new file mode 100644
index 000000000000..3fd8ecfc3268
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ResumeProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/StopProtection.json
new file mode 100644
index 000000000000..3fd8ecfc3268
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/StopProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SuspendBackups.json
new file mode 100644
index 000000000000..3fd8ecfc3268
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SuspendBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json
new file mode 100644
index 000000000000..7dc803e38b3c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "syncType": "Default"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerBackup.json
new file mode 100644
index 000000000000..26cbeefcdbd5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerBackup.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupRuleOptions": {
+ "ruleName": "BackupWeekly",
+ "triggerOption": {
+ "retentionTagOverride": "yearly"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json
new file mode 100644
index 000000000000..1e634cce7520
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestore.json
new file mode 100644
index 000000000000..99548cec57af
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestore.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
new file mode 100644
index 000000000000..b364482f991c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "targetDetails": {
+ "url": "https://teststorage.blob.core.windows.net/restoretest",
+ "filePrefix": "restoredblob",
+ "restoreTargetLocationType": "AzureBlobs"
+ },
+ "restoreLocation": "southeastasia",
+ "recoveryOption": "FailIfExists",
+ "objectType": "RestoreFilesTargetInfo"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
new file mode 100644
index 000000000000..60869a06f859
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRestoreWithRehydrationRequest",
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json
new file mode 100644
index 000000000000..55ba5ac72a6b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupInstance": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateRestore.json
new file mode 100644
index 000000000000..eb3757660369
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/BackupInstanceOperations/ValidateRestore.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "restoreRequestObject": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/CheckfeatureSupport.json
new file mode 100644
index 000000000000..d8925d3b0420
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/CheckfeatureSupport.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "featureType": "DataSourceType",
+ "objectType": "FeatureValidationRequest"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "featureType": "DataSourceType",
+ "features": [
+ {
+ "featureName": "Microsoft.Storage/storageAccounts/blobServices",
+ "supportStatus": "PrivatePreview",
+ "exposureControlledFeatures": []
+ },
+ {
+ "featureName": "Microsoft.DBforPostgreSQL/servers/databases",
+ "supportStatus": "PublicPreview",
+ "exposureControlledFeatures": []
+ }
+ ],
+ "objectType": "FeatureValidationResponse"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
new file mode 100644
index 000000000000..c8924558777e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
new file mode 100644
index 000000000000..337d94730c59
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
new file mode 100644
index 000000000000..eed8a8e962b9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-07-01-preview",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-07-01-preview",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationResult.json
new file mode 100644
index 000000000000..68d5772b702f
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationResult.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatus.json
new file mode 100644
index 000000000000..eb6fab07bf70
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatus.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusRGContext.json
new file mode 100644
index 000000000000..f14d5847a068
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusRGContext.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusVaultContext.json
new file mode 100644
index 000000000000..7483cdc46252
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/GetOperationStatusVaultContext.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json
new file mode 100644
index 000000000000..e6cf7c0c9f02
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "operationId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000",
+ "blobSasKey": "someKey",
+ "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx",
+ "excelFileBlobSasKey": "someKey"
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": 60,
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-11-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetJob.json
new file mode 100644
index 000000000000..53f51da8f7b4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/GetJob.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap",
+ "extendedInfo": {
+ "subTasks": [
+ {
+ "taskId": 1,
+ "taskName": "Trigger Backup",
+ "taskStatus": "Started"
+ }
+ ],
+ "additionalDetails": {
+ "RetentionTag": "Default",
+ "PolicyRuleName": "BackupWeekly",
+ "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"
+ }
+ }
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/ListJobs.json
new file mode 100644
index 000000000000..226830deb46e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/ListJobs.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4",
+ "policyName": "jakavetPolicy2",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb4",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T05:00:08.1746833Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002",
+ "name": "8989416e-7573-4836-8cf1-0e90954f1002",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5",
+ "policyName": "jakavetPolicy3",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb5",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T18:00:03.6660733Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3",
+ "policyName": "jakavetPolicy1",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb3",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T11:11:50.5595259Z",
+ "endTime": "2021-03-17T11:14:02.5319646Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Succeeded",
+ "isUserTriggered": true,
+ "supportedActions": [
+ ""
+ ],
+ "duration": "00:02:11.9724387",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097",
+ "name": "43252662-1b43-44fd-a856-0055665cb097",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/TriggerExportJobs.json
new file mode 100644
index 000000000000..1605518733a8
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/JobCRUD/TriggerExportJobs.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-11-01-preview",
+ "Retry-After": 60
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/Operations/List.json
new file mode 100644
index 000000000000..c42a2c68fd5c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/Operations/List.json
@@ -0,0 +1,533 @@
+{
+ "parameters": {
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataProtection/locations/getBackupStatus/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Status",
+ "operation": "Check Backup Status for Vault",
+ "description": "Check Backup Status for Recovery Services Vaults"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Create a Backup Instance",
+ "description": "Creates a Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Delete Backup Instance",
+ "description": "Deletes the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instance Details",
+ "description": "Returns details of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instances",
+ "description": "Returns all Backup Instances"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Backup Backup Instance",
+ "description": "Performs Backup on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Sync Backup Instance",
+ "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Stop Protection of Backup Instance",
+ "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Suspend Backups of Backup Instance",
+ "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Protection of Backup Instance",
+ "description": "Resume protection of a ProtectionStopped BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Backups of Backup Instance",
+ "description": "Resume Backups for a BackupsSuspended BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Validate for Restore of Backup Instance",
+ "description": "Validates for Restore of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Restore Backup Instance",
+ "description": "Triggers restore on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Create Backup Policy",
+ "description": "Creates Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Delete Backup Policy",
+ "description": "Deletes the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policy details",
+ "description": "Returns details of the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policies",
+ "description": "Returns all Backup Policies"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get the list of ResourceGuard proxies for a resource",
+ "description": "Get the list of ResourceGuard proxies for a resource"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get ResourceGuard proxy",
+ "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Create ResourceGuard proxy",
+ "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Delete ResourceGuard proxy",
+ "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation",
+ "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Point Details",
+ "description": "Returns details of the Recovery Point"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Points",
+ "description": "Returns all Recovery Points"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Restorable Time Ranges",
+ "operation": "Find Restorable Time Ranges",
+ "description": "Finds Restorable Time Ranges"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Operation Result of a Patch Operation for a Backup Vault",
+ "description": "Gets Operation Result of a Patch Operation for a Backup Vault"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/checkNameAvailability/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Check if the requested BackupVault Name is Available",
+ "description": "Checks if the requested BackupVault Name is Available"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Resource Group",
+ "description": "Gets list of Backup Vaults in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Subscription",
+ "description": "Gets list of Backup Vaults in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Create ResourceGuard",
+ "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard",
+ "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Delete ResourceGuard",
+ "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Resource Group",
+ "description": "Gets list of ResourceGuards in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Subscription",
+ "description": "Gets list of ResourceGuards in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Update ResourceGuard",
+ "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard operation request info",
+ "description": "Gets ResourceGuard operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard default operation request info",
+ "description": "Gets ResourceGuard default operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Validate if a feature is supported",
+ "description": "Validates if a feature is supported"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Results",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Validate Backup",
+ "operation": "Validate for backup of Backup Instance",
+ "description": "Validates for backup of Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Jobs",
+ "description": "Get Jobs list"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Job Object",
+ "description": "Get Job details"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/register/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Register Resource Provider",
+ "description": "Registers subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/unregister/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Unregister Resource Provider",
+ "description": "Unregisters subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/operations/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "List of Operations",
+ "description": "Operation returns the list of Operations for a Resource Provider"
+ },
+ "origin": "user"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
new file mode 100644
index 000000000000..94fada0cf9c7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
@@ -0,0 +1,200 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json
new file mode 100644
index 000000000000..fbc1ba7b8a2e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/GetBackupPolicy.json
new file mode 100644
index 000000000000..720f2b24990d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/GetBackupPolicy.json
@@ -0,0 +1,109 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/ListBackupPolicy.json
new file mode 100644
index 000000000000..dc5abb2fc6e8
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/PolicyCRUD/ListBackupPolicy.json
@@ -0,0 +1,112 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json
new file mode 100644
index 000000000000..f3de1746394c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..2fd2e3055ec9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..9c649e5e3332
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..7cd6d0f903ad
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..928237fef511
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..241ae16b78a4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..31ebcde67ffd
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json
new file mode 100644
index 000000000000..18b4d2029799
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "ResourceGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
new file mode 100644
index 000000000000..8ba29b9fadac
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
new file mode 100644
index 000000000000..34dc97bade96
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..1c65ff595990
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..60130ddb3ac7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..76d219b0ee3a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..06d1b6196df9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..88ec3c667059
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..189049378078
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json
new file mode 100644
index 000000000000..538019d2d51a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json
new file mode 100644
index 000000000000..e860945c52f6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json
new file mode 100644
index 000000000000..f955695db126
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
+ "vaultName": "sampleVault",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardProxyName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json
new file mode 100644
index 000000000000..7e095b4804fb
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
+ "vaultName": "sampleVault",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardProxyName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies",
+ "properties": {
+ "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource",
+ "resourceGuardOperationDetails": [
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"
+ }
+ ],
+ "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z",
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json
new file mode 100644
index 000000000000..685c49769ee2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
+ "vaultName": "sampleVault",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies",
+ "properties": {
+ "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource",
+ "resourceGuardOperationDetails": [
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"
+ }
+ ],
+ "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z",
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json
new file mode 100644
index 000000000000..64426b20bd66
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
+ "vaultName": "sampleVault",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardProxyName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "properties": {
+ "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies",
+ "properties": {
+ "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource",
+ "resourceGuardOperationDetails": [
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default"
+ }
+ ],
+ "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z",
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json
new file mode 100644
index 000000000000..245a057bb11e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
+ "vaultName": "sampleVault",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardProxyName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "resourceGuardOperationRequests": [
+ "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default"
+ ],
+ "resourceToBeDeleted": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupInstances/TestBI9779f4de"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "unlockDeleteExpiryTime": "2022-09-16T12:50:10.7039695Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
new file mode 100644
index 000000000000..9d9a13bb9a43
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "location": "westus",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "name": "swaggerExample"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/DeleteBackupVault.json
new file mode 100644
index 000000000000..4afb962f4bd8
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/DeleteBackupVault.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "204": {},
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVault.json
new file mode 100644
index 000000000000..5d92b8df92db
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVault.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json
new file mode 100644
index 000000000000..61285e714852
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
new file mode 100644
index 000000000000..b6ff78dfd890
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json
new file mode 100644
index 000000000000..632306356705
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetOperationResultPatch.json
new file mode 100644
index 000000000000..2bc09545d96e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/GetOperationResultPatch.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2022-11-01-preview"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ },
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Retry-After": "60"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PatchBackupVault.json
new file mode 100644
index 000000000000..d73f021fa833
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PatchBackupVault.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVault.json
new file mode 100644
index 000000000000..ee3a5ab94062
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVault.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json
new file mode 100644
index 000000000000..52466f4df6ff
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2022-11-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-11-01-preview",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "systemAssigned"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-11-01-preview"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/dataprotection.json
new file mode 100644
index 000000000000..86c5ec7ced50
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/dataprotection.json
@@ -0,0 +1,6860 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01",
+ "title": "DataProtectionBackupClient",
+ "x-ms-code-generation-settings": {
+ "internalConstructors": false
+ }
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a subscription.",
+ "operationId": "BackupVaults_GetInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in Subscription": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "GetOperationResult"
+ ],
+ "description": "Gets the operation result for a resource",
+ "operationId": "OperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets the operation status for a resource.",
+ "x-ms-examples": {
+ "Get OperationResult": {
+ "$ref": "./examples/GetOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for a resource.",
+ "operationId": "OperationStatus_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatus.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a BackupVault's context.",
+ "operationId": "OperationStatusBackupVaultContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusVaultContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a ResourceGroup's context.",
+ "operationId": "OperationStatusResourceGroupContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusRGContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a resource group.",
+ "operationId": "BackupVaults_GetInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in ResourceGroup": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns a resource belonging to a resource group.",
+ "operationId": "BackupVaults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupVault": {
+ "$ref": "./examples/VaultCRUD/GetBackupVault.json"
+ },
+ "Get BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Creates or updates a BackupVault resource belonging to a resource group.",
+ "operationId": "BackupVaults_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupVault": {
+ "$ref": "./examples/VaultCRUD/PutBackupVault.json"
+ },
+ "Create BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Deletes a BackupVault resource from the resource group.",
+ "operationId": "BackupVaults_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupVault": {
+ "$ref": "./examples/VaultCRUD/DeleteBackupVault.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "BackupVaults_Update",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceRequestInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Patch BackupVault": {
+ "$ref": "./examples/VaultCRUD/PatchBackupVault.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "BackupVaultOperationResults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetOperationResult Patch": {
+ "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "summary": "API to check for resource name availability",
+ "operationId": "BackupVaults_CheckNameAvailability",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "The location in which uniqueness will be verified.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Check name availability request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check BackupVaults name availability": {
+ "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": {
+ "post": {
+ "tags": [
+ "DppFeatureSupport"
+ ],
+ "summary": "Validates if a feature is supported",
+ "operationId": "DataProtection_CheckFeatureSupport",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Feature support request object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check Azure Vm Backup Feature Support": {
+ "$ref": "./examples/CheckfeatureSupport.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.DataProtection/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Returns the list of available operations.",
+ "operationId": "DataProtectionOperations_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClientDiscoveryResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "value"
+ },
+ "x-ms-examples": {
+ "Returns the list of supported REST operations.": {
+ "$ref": "./examples/Operations/List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "description": "Returns list of backup policies belonging to a backup vault",
+ "operationId": "BackupPolicies_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Get",
+ "description": "Gets a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets a backup policy belonging to a backup vault",
+ "x-ms-examples": {
+ "Get BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_CreateOrUpdate",
+ "summary": "Creates or Updates a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "description": "Name of the policy",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CreateOrUpdate BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Delete",
+ "summary": "Deletes a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instances belonging to a backup vault",
+ "operationId": "BackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupInstances in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instance with name in a backup vault",
+ "operationId": "BackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Create or update a backup instance in a backup vault",
+ "operationId": "BackupInstances_CreateOrUpdate",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Delete a backup instance in a backup vault",
+ "operationId": "BackupInstances_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "200": {
+ "description": "Ok"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Trigger adhoc backup ",
+ "operationId": "BackupInstances_AdhocBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Trigger Adhoc Backup": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validate whether adhoc backup will be successful or not",
+ "operationId": "BackupInstances_ValidateForBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateForBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Validate For Backup": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Get result of backup instance creation operation",
+ "operationId": "BackupInstances_GetBackupInstanceOperationResult",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstanceOperationResult": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Returns a list of Recovery Points for a DataSource in a vault.",
+ "operationId": "RecoveryPoints_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "OData filter options.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "skipToken Filter.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/RecoveryPointsFilters",
+ "x-ms-examples": {
+ "List Recovery Points in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Gets a Recovery Point using recoveryPointId for a Datasource.",
+ "operationId": "RecoveryPoints_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "recoveryPointId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Recovery Point": {
+ "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": {
+ "post": {
+ "description": "rehydrate recovery point for restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRehydrate",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "description": "Request body for operation",
+ "in": "body",
+ "name": "parameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRehydrationRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "tags": [
+ "BackupInstances"
+ ],
+ "x-ms-examples": {
+ "Trigger Rehydrate": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Triggers restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Trigger Restore": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json"
+ },
+ "Trigger Restore As Files": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json"
+ },
+ "Trigger Restore With Rehydration": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume backups for backup instance",
+ "operationId": "BackupInstances_ResumeBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeBackups": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume protection for a stopped backup instance",
+ "operationId": "BackupInstances_ResumeProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeProtection": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop protection of a backup instance and data will be held forever",
+ "operationId": "BackupInstances_StopProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StopProtection": {
+ "$ref": "./examples/BackupInstanceOperations/StopProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)",
+ "operationId": "BackupInstances_SuspendBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SuspendBackups": {
+ "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state",
+ "operationId": "BackupInstances_SyncBackupInstance",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncBackupInstanceRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Sync BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validates if Restore can be triggered for a DataSource",
+ "operationId": "BackupInstances_ValidateForRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateRestoreRequestObject"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Validate Restore": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": {
+ "get": {
+ "tags": [
+ "AzureBackupJobs"
+ ],
+ "description": "Returns list of jobs belonging to a backup vault",
+ "operationId": "Jobs_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get Jobs": {
+ "$ref": "./examples/JobCRUD/ListJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": {
+ "post": {
+ "tags": [
+ "FindRestorableTimeRanges"
+ ],
+ "operationId": "RestorableTimeRanges_Find",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Find Restorable Time Ranges": {
+ "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets a job with id in a backup vault",
+ "operationId": "Jobs_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "jobId",
+ "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Job": {
+ "$ref": "./examples/JobCRUD/GetJob.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": {
+ "post": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Triggers export of jobs and returns an OperationID to track.",
+ "operationId": "ExportJobs_Trigger",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Trigger Export Jobs": {
+ "$ref": "./examples/JobCRUD/TriggerExportJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.",
+ "operationId": "ExportJobsOperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "description": "OperationID which represents the export job.",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExportJobsResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Export Jobs Operation Result": {
+ "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets deleted backup instances belonging to a backup vault",
+ "operationId": "DeletedBackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List DeletedBackupInstances in a Vault": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets a deleted backup instance with name in a backup vault",
+ "operationId": "DeletedBackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DeletedBackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete": {
+ "post": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "operationId": "DeletedBackupInstances_Undelete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Undelete Deleted BackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a subscription.",
+ "operationId": "ResourceGuards_GetResourcesInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in Subscription": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a ResourceGroup.",
+ "operationId": "ResourceGuards_GetResourcesInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in ResourceGroup": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}": {
+ "put": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Creates or updates a ResourceGuard resource belonging to a resource group.",
+ "operationId": "ResourceGuards_Put",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PutResourceGuard.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns a ResourceGuard belonging to a resource group.",
+ "operationId": "ResourceGuards_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuard.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Deletes a ResourceGuard resource from the resource group.",
+ "operationId": "ResourceGuards_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/DeleteResourceGuard.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "ResourceGuards_Patch",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceGuardInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PatchResourceGuard.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDisableSoftDeleteRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetBackupSecurityPINRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AbsoluteDeleteOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeleteOption"
+ }
+ ],
+ "description": "Delete option with duration",
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "AbsoluteDeleteOption",
+ "type": "object",
+ "x-ms-discriminator-value": "AbsoluteDeleteOption"
+ },
+ "RecoveryPointsFilters": {
+ "type": "object",
+ "properties": {
+ "restorePointDataStoreId": {
+ "type": "string"
+ },
+ "isVisible": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "extendedInfo": {
+ "type": "boolean"
+ },
+ "restorePointState": {
+ "type": "string"
+ }
+ }
+ },
+ "AdHocBackupRuleOptions": {
+ "description": "Adhoc backup rules",
+ "properties": {
+ "ruleName": {
+ "type": "string"
+ },
+ "triggerOption": {
+ "$ref": "#/definitions/AdhocBackupTriggerOption"
+ }
+ },
+ "required": [
+ "ruleName",
+ "triggerOption"
+ ],
+ "title": "AdHocBackupRuleOptions",
+ "type": "object"
+ },
+ "AdhocBackupTriggerOption": {
+ "description": "Adhoc backup trigger option",
+ "properties": {
+ "retentionTagOverride": {
+ "type": "string"
+ }
+ },
+ "title": "AdhocBackupTriggerOption",
+ "type": "object"
+ },
+ "AdhocBasedTaggingCriteria": {
+ "description": "Adhoc backup tagging criteria",
+ "properties": {
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "title": "AdhocBasedTaggingCriteria",
+ "type": "object"
+ },
+ "AdhocBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Adhoc trigger context",
+ "properties": {
+ "taggingCriteria": {
+ "$ref": "#/definitions/AdhocBasedTaggingCriteria",
+ "description": "Tagging Criteria containing retention tag for adhoc backup."
+ }
+ },
+ "required": [
+ "objectType",
+ "taggingCriteria"
+ ],
+ "title": "AdhocBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "AdhocBasedTriggerContext"
+ },
+ "AuthCredentials": {
+ "description": "Base class for different types of authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "AzureBackupDiscreteRecoveryPoint": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint"
+ }
+ ],
+ "description": "Azure backup discrete RecoveryPoint",
+ "properties": {
+ "friendlyName": {
+ "type": "string"
+ },
+ "recoveryPointDataStoresDetails": {
+ "items": {
+ "$ref": "#/definitions/RecoveryPointDataStoreDetails"
+ },
+ "type": "array"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "policyName": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "type": "string"
+ },
+ "recoveryPointId": {
+ "type": "string"
+ },
+ "recoveryPointType": {
+ "type": "string"
+ },
+ "retentionTagName": {
+ "type": "string"
+ },
+ "retentionTagVersion": {
+ "type": "string"
+ },
+ "expiryTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupDiscreteRecoveryPoint",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint"
+ },
+ "AzureBackupFindRestorableTimeRangesRequest": {
+ "description": "List Restore Ranges Request",
+ "required": [
+ "sourceDataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreSourceDataStoreType",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "description": "Start time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesRequestResource": {
+ "description": "List Restore Ranges Request",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppWorkerRequest"
+ }
+ ],
+ "properties": {
+ "content": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest",
+ "description": "AzureBackupFindRestorableTimeRangesRequestResource content"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponse": {
+ "description": "List Restore Ranges Response",
+ "type": "object",
+ "properties": {
+ "restorableTimeRanges": {
+ "description": "Returns the Restore Ranges available on the Backup Instance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RestorableTimeRange"
+ },
+ "x-ms-identifiers": []
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponseResource": {
+ "description": "List Restore Ranges Response",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse",
+ "description": "AzureBackupFindRestorableTimeRangesResponseResource properties"
+ }
+ }
+ },
+ "AzureBackupJob": {
+ "description": "AzureBackup Job Class",
+ "properties": {
+ "activityID": {
+ "description": "Job Activity Id",
+ "type": "string"
+ },
+ "backupInstanceFriendlyName": {
+ "description": "Name of the Backup Instance",
+ "type": "string"
+ },
+ "backupInstanceId": {
+ "description": "ARM ID of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "ARM ID of the DataSource",
+ "type": "string"
+ },
+ "dataSourceLocation": {
+ "description": "Location of the DataSource",
+ "type": "string"
+ },
+ "dataSourceName": {
+ "description": "User Friendly Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceSetName": {
+ "description": "Data Source Set Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceType": {
+ "description": "Type of DataSource",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Total run time of the job. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "EndTime of the job(in UTC)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "A List, detailing the errors related to the job",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "extendedInfo": {
+ "$ref": "#/definitions/JobExtendedInfo",
+ "description": "Extended Information about the job",
+ "readOnly": true
+ },
+ "isUserTriggered": {
+ "description": "Indicated that whether the job is adhoc(true) or scheduled(false)",
+ "type": "boolean"
+ },
+ "operation": {
+ "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure",
+ "type": "string"
+ },
+ "operationCategory": {
+ "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management",
+ "type": "string"
+ },
+ "policyId": {
+ "description": "ARM ID of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyName": {
+ "description": "Name of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "progressEnabled": {
+ "description": "Indicated whether progress is enabled for the job",
+ "type": "boolean"
+ },
+ "progressUrl": {
+ "description": "Url which contains job's progress",
+ "readOnly": true,
+ "type": "string"
+ },
+ "restoreType": {
+ "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceResourceGroup": {
+ "description": "Resource Group Name of the Datasource",
+ "type": "string"
+ },
+ "sourceSubscriptionID": {
+ "description": "SubscriptionId corresponding to the DataSource",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "StartTime of the job(in UTC)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning",
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "Subscription Id of the corresponding backup vault",
+ "type": "string"
+ },
+ "supportedActions": {
+ "description": "List of supported actions",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vaultName": {
+ "description": "Name of the vault",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "sourceDataStoreName": {
+ "type": "string"
+ },
+ "destinationDataStoreName": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "activityID",
+ "subscriptionId",
+ "dataSourceId",
+ "vaultName",
+ "backupInstanceFriendlyName",
+ "sourceResourceGroup",
+ "dataSourceName",
+ "progressEnabled",
+ "sourceSubscriptionID",
+ "dataSourceLocation",
+ "startTime",
+ "dataSourceType",
+ "operationCategory",
+ "operation",
+ "status",
+ "isUserTriggered",
+ "supportedActions"
+ ],
+ "type": "object"
+ },
+ "AzureBackupJobResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "AzureBackup Job Resource Class",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupJob",
+ "description": "AzureBackupJobResource properties",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupJobResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of AzureBackup Job resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupParams": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupParameters"
+ }
+ ],
+ "description": "Azure backup parameters",
+ "properties": {
+ "backupType": {
+ "description": "BackupType ; Full/Incremental etc",
+ "type": "string"
+ }
+ },
+ "required": [
+ "backupType",
+ "objectType"
+ ],
+ "title": "AzureBackupParams",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupParams"
+ },
+ "AzureBackupRecoveryPoint": {
+ "description": "Azure backup recoveryPoint",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "AzureBackupRecoveryPoint",
+ "type": "object"
+ },
+ "AzureBackupRecoveryPointBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "Azure backup recoveryPoint based restore request",
+ "properties": {
+ "recoveryPointId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId"
+ ],
+ "title": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest"
+ },
+ "AzureBackupRecoveryPointResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint",
+ "description": "AzureBackupRecoveryPointResource properties"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResource"
+ },
+ "AzureBackupRecoveryPointResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource list",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResourceList",
+ "type": "object"
+ },
+ "AzureBackupRehydrationRequest": {
+ "description": "Azure Backup Rehydrate Request",
+ "properties": {
+ "recoveryPointId": {
+ "description": "Id of the recovery point to be recovered",
+ "type": "string"
+ },
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRehydrationRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreRequest": {
+ "description": "Azure backup restore request",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ },
+ "restoreTargetInfo": {
+ "$ref": "#/definitions/RestoreTargetInfoBase",
+ "description": "Gets or sets the restore target information."
+ },
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "ArchiveStore",
+ "SnapshotStore",
+ "OperationalStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "SourceDataStoreType"
+ }
+ },
+ "sourceResourceId": {
+ "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "restoreTargetInfo",
+ "sourceDataStoreType"
+ ],
+ "title": "AzureBackupRestoreRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreWithRehydrationRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup Restore with Rehydration Request",
+ "properties": {
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "rehydrationPriority",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRestoreWithRehydrationRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest"
+ },
+ "AzureBackupRecoveryTimeBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup RecoveryPointTime Based Restore Request",
+ "properties": {
+ "recoveryPointTime": {
+ "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupRecoveryTimeBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest"
+ },
+ "AzureBackupRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure backup rule",
+ "properties": {
+ "backupParameters": {
+ "$ref": "#/definitions/BackupParameters"
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "trigger": {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ },
+ "required": [
+ "dataStore",
+ "name",
+ "objectType",
+ "trigger"
+ ],
+ "title": "AzureBackupRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRule"
+ },
+ "AzureMonitorAlertSettings": {
+ "type": "object",
+ "description": "Settings for Azure Monitor based alerts",
+ "properties": {
+ "alertsForAllJobFailures": {
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AlertsState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AzureOperationalStoreParameters": {
+ "description": "Parameters for Operational-Tier DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataStoreParameters"
+ }
+ ],
+ "properties": {
+ "resourceGroupId": {
+ "description": "Gets or sets the Snapshot Resource Group Uri.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "AzureOperationalStoreParameters"
+ },
+ "AzureRetentionRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure retention rule",
+ "properties": {
+ "isDefault": {
+ "type": "boolean"
+ },
+ "lifecycles": {
+ "items": {
+ "$ref": "#/definitions/SourceLifeCycle"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "lifecycles",
+ "name",
+ "objectType"
+ ],
+ "title": "AzureRetentionRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureRetentionRule"
+ },
+ "BackupCriteria": {
+ "description": "BackupCriteria base class",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupCriteria",
+ "type": "object"
+ },
+ "BackupInstance": {
+ "description": "Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo",
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "friendlyName": {
+ "description": "Gets or sets the Backup Instance friendly name.",
+ "type": "string"
+ },
+ "dataSourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Gets or sets the data source information."
+ },
+ "dataSourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Gets or sets the data source set information."
+ },
+ "policyInfo": {
+ "$ref": "#/definitions/PolicyInfo",
+ "description": "Gets or sets the policy information."
+ },
+ "protectionStatus": {
+ "$ref": "#/definitions/ProtectionStatusDetails",
+ "description": "Specifies the protection status of the resource",
+ "readOnly": true
+ },
+ "currentProtectionState": {
+ "description": "Specifies the current protection state of the resource",
+ "enum": [
+ "Invalid",
+ "NotProtected",
+ "ConfiguringProtection",
+ "ProtectionConfigured",
+ "BackupSchedulesSuspended",
+ "RetentionSchedulesSuspended",
+ "ProtectionStopped",
+ "ProtectionError",
+ "ConfiguringProtectionFailed",
+ "SoftDeleting",
+ "SoftDeleted",
+ "UpdatingProtection"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CurrentProtectionState",
+ "modelAsString": true
+ }
+ },
+ "protectionErrorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection error of the resource",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed",
+ "type": "string",
+ "readOnly": true
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "validationType": {
+ "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.",
+ "enum": [
+ "ShallowValidation",
+ "DeepValidation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationType",
+ "modelAsString": true
+ }
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "BackupInstanceResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppProxyResource"
+ }
+ ],
+ "description": "BackupInstance Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupInstance",
+ "description": "BackupInstanceResource properties"
+ }
+ },
+ "title": "BackupInstanceResource"
+ },
+ "BackupInstanceResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "BackupInstance Resource list response",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupInstanceResourceList",
+ "type": "object"
+ },
+ "BackupParameters": {
+ "description": "BackupParameters base",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupParameters",
+ "type": "object"
+ },
+ "BackupPolicy": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BaseBackupPolicy"
+ }
+ ],
+ "description": "Rule based backup policy",
+ "properties": {
+ "policyRules": {
+ "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc",
+ "items": {
+ "$ref": "#/definitions/BasePolicyRule"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "policyRules"
+ ],
+ "title": "BackupPolicy",
+ "type": "object",
+ "x-ms-discriminator-value": "BackupPolicy"
+ },
+ "BackupSchedule": {
+ "description": "Schedule for backup",
+ "properties": {
+ "repeatingTimeIntervals": {
+ "description": "ISO 8601 repeating time interval format",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "timeZone": {
+ "description": "Time zone for a schedule. Example: Pacific Standard Time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "repeatingTimeIntervals"
+ ],
+ "title": "BackupSchedule",
+ "type": "object"
+ },
+ "BackupVault": {
+ "description": "Backup Vault",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "ProvisioningState"
+ }
+ },
+ "resourceMoveState": {
+ "description": "Resource move state for backup vault",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "PrepareFailed",
+ "CommitFailed",
+ "Failed",
+ "PrepareTimedout",
+ "CommitTimedout",
+ "CriticalFailure",
+ "PartialSuccess",
+ "MoveSucceeded"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ResourceMoveState",
+ "modelAsString": true
+ }
+ },
+ "resourceMoveDetails": {
+ "$ref": "#/definitions/ResourceMoveDetails",
+ "description": "Resource move details for backup vault",
+ "readOnly": true
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ },
+ "storageSettings": {
+ "description": "Storage Settings",
+ "items": {
+ "$ref": "#/definitions/StorageSetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isVaultProtectedByResourceGuard": {
+ "description": "Is vault protected by resource guard",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "featureSettings": {
+ "$ref": "#/definitions/FeatureSettings",
+ "description": "Feature Settings"
+ }
+ },
+ "required": [
+ "storageSettings"
+ ],
+ "title": "BackupVault",
+ "type": "object"
+ },
+ "BackupVaultResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResource"
+ }
+ ],
+ "description": "Backup Vault Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupVault",
+ "description": "BackupVaultResource properties"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "title": "BackupVault Resource"
+ },
+ "BackupVaultResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BackupVault resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupVaultResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupVaultResourceList",
+ "type": "object"
+ },
+ "BaseBackupPolicy": {
+ "description": "BackupPolicy base",
+ "discriminator": "objectType",
+ "properties": {
+ "datasourceTypes": {
+ "description": "Type of datasource for the backup management",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "objectType"
+ ],
+ "title": "BaseBackupPolicy",
+ "type": "object"
+ },
+ "BaseBackupPolicyResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "BaseBackupPolicy resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BaseBackupPolicy",
+ "description": "BaseBackupPolicyResource properties"
+ }
+ },
+ "title": "BaseBackupPolicyResource"
+ },
+ "BaseBackupPolicyResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BaseBackupPolicy resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BaseBackupPolicyResourceList",
+ "type": "object"
+ },
+ "BasePolicyRule": {
+ "description": "BasePolicy Rule",
+ "discriminator": "objectType",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "objectType"
+ ],
+ "title": "BasePolicyRule",
+ "type": "object"
+ },
+ "CheckNameAvailabilityRequest": {
+ "description": "CheckNameAvailability Request",
+ "properties": {
+ "name": {
+ "description": "Resource name for which availability needs to be checked",
+ "type": "string"
+ },
+ "type": {
+ "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityRequest",
+ "type": "object"
+ },
+ "CheckNameAvailabilityResult": {
+ "description": "CheckNameAvailability Result",
+ "properties": {
+ "message": {
+ "description": "Gets or sets the message.",
+ "type": "string"
+ },
+ "nameAvailable": {
+ "description": "Gets or sets a value indicating whether [name available].",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "Gets or sets the reason.",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityResult",
+ "type": "object"
+ },
+ "ClientDiscoveryDisplay": {
+ "description": "Localized display information of an operation.",
+ "properties": {
+ "description": {
+ "description": "Description of the operation having details of what operation is about.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operations Name itself.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Name of the provider for display purposes",
+ "type": "string"
+ },
+ "resource": {
+ "description": "ResourceType for which this Operation can be performed.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryDisplay",
+ "type": "object"
+ },
+ "ClientDiscoveryForLogSpecification": {
+ "description": "Class to represent shoebox log specification in json client discovery.",
+ "properties": {
+ "blobDuration": {
+ "description": "blob duration of shoebox log specification",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name for shoebox log specification.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryForLogSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryForProperties": {
+ "description": "Class to represent shoebox properties in json client discovery.",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ClientDiscoveryForServiceSpecification",
+ "description": "Operation properties."
+ }
+ },
+ "title": "ClientDiscoveryForProperties",
+ "type": "object"
+ },
+ "ClientDiscoveryForServiceSpecification": {
+ "description": "Class to represent shoebox service specification in json client discovery.",
+ "properties": {
+ "logSpecifications": {
+ "description": "List of log specifications of this operation.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryForLogSpecification"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryForServiceSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryResponse": {
+ "description": "Operations List response which contains list of available APIs.",
+ "properties": {
+ "nextLink": {
+ "description": "Link to the next chunk of Response.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of available operations.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryValueForSingleApi"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryResponse",
+ "type": "object"
+ },
+ "ClientDiscoveryValueForSingleApi": {
+ "description": "Available operation details.",
+ "properties": {
+ "display": {
+ "$ref": "#/definitions/ClientDiscoveryDisplay",
+ "description": "Contains the localized display information for this particular operation"
+ },
+ "name": {
+ "description": "Name of the Operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ },
+ "origin": {
+ "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/ClientDiscoveryForProperties",
+ "description": "Properties for the given operation."
+ }
+ },
+ "title": "ClientDiscoveryValueForSingleApi",
+ "type": "object"
+ },
+ "CloudError": {
+ "description": "An error response from Azure Backup.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "title": "CloudError",
+ "x-ms-external": true
+ },
+ "CopyOnExpiryOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Copy on Expiry Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOnExpiryOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CopyOnExpiryOption"
+ },
+ "CopyOption": {
+ "description": "Options to copy",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOption",
+ "type": "object"
+ },
+ "CrossSubscriptionRestoreSettings": {
+ "description": "CrossSubscriptionRestore Settings",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "CrossSubscriptionRestore state",
+ "enum": [
+ "Disabled",
+ "PermanentlyDisabled",
+ "Enabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CrossSubscriptionRestoreState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CustomCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Duration based custom options to copy",
+ "properties": {
+ "duration": {
+ "description": "Data copied after given timespan",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CustomCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CustomCopyOption"
+ },
+ "Datasource": {
+ "description": "Datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "Datasource",
+ "type": "object"
+ },
+ "DatasourceSet": {
+ "description": "DatasourceSet details of datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "DatasourceSet",
+ "type": "object"
+ },
+ "DataStoreInfoBase": {
+ "description": "DataStoreInfo base",
+ "properties": {
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DataStoreTypes"
+ }
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "readOnly": false,
+ "type": "string"
+ }
+ },
+ "required": [
+ "dataStoreType",
+ "objectType"
+ ],
+ "title": "DataStoreInfoBase",
+ "type": "object"
+ },
+ "DataStoreParameters": {
+ "description": "Parameters for DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ },
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataStoreTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "Day": {
+ "description": "Day of the week",
+ "properties": {
+ "date": {
+ "description": "Date of the month",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isLast": {
+ "description": "Whether Date is last date of month",
+ "type": "boolean"
+ }
+ },
+ "title": "Day",
+ "type": "object"
+ },
+ "DeletedBackupInstance": {
+ "description": "Deleted Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ ],
+ "properties": {
+ "deletionInfo": {
+ "$ref": "#/definitions/DeletionInfo",
+ "description": "Deletion info of Backup Instance",
+ "readOnly": true
+ }
+ }
+ },
+ "DeletedBackupInstanceResource": {
+ "description": "Deleted Backup Instance",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeletedBackupInstance",
+ "description": "DeletedBackupInstanceResource properties"
+ }
+ }
+ },
+ "DeletedBackupInstanceResourceList": {
+ "description": "List of DeletedBackupInstance resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ }
+ }
+ },
+ "DeletionInfo": {
+ "description": "Deletion Info",
+ "type": "object",
+ "properties": {
+ "deletionTime": {
+ "description": "Specifies time of deletion",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingEndDate": {
+ "description": "Specifies billing end date",
+ "type": "string",
+ "readOnly": true
+ },
+ "scheduledPurgeTime": {
+ "description": "Specifies purge time",
+ "type": "string",
+ "readOnly": true
+ },
+ "deleteActivityID": {
+ "description": "Delete activity ID for troubleshooting purpose",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DeleteOption": {
+ "description": "Delete Option",
+ "discriminator": "objectType",
+ "properties": {
+ "duration": {
+ "description": "Duration of deletion after given timespan",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "DeleteOption",
+ "type": "object"
+ },
+ "DppIdentityDetails": {
+ "description": "Identity details",
+ "properties": {
+ "principalId": {
+ "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "The identityType which can be either SystemAssigned or None",
+ "type": "string"
+ }
+ },
+ "title": "DppIdentityDetails",
+ "type": "object"
+ },
+ "DppBaseResourceList": {
+ "description": "Base for all lists of V2 resources.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Dpp resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "DppBaseResource": {
+ "type": "object",
+ "description": "Base resource under Microsoft.DataProtection provider namespace",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DppResource": {
+ "description": "Resource class",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "title": "DppResource",
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppResourceList": {
+ "description": "ListResource",
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "title": "List Resource",
+ "type": "object"
+ },
+ "DppBaseTrackedResource": {
+ "properties": {
+ "eTag": {
+ "description": "Optional ETag.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppTrackedResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppBaseTrackedResource"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "ImmutabilitySettings": {
+ "description": "Immutability Settings at vault level",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "Immutability state",
+ "enum": [
+ "Disabled",
+ "Unlocked",
+ "Locked"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImmutabilityState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DppProxyResource": {
+ "properties": {
+ "id": {
+ "description": "Proxy Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Proxy Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Proxy Resource tags.",
+ "type": "object"
+ },
+ "systemData": {
+ "$ref": "#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "systemData": {
+ "description": "Metadata pertaining to creation and last modification of the resource.",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "createdBy": {
+ "type": "string",
+ "description": "The identity that created the resource."
+ },
+ "createdByType": {
+ "type": "string",
+ "description": "The type of identity that created the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of resource creation (UTC)."
+ },
+ "lastModifiedBy": {
+ "type": "string",
+ "description": "The identity that last modified the resource."
+ },
+ "lastModifiedByType": {
+ "type": "string",
+ "description": "The type of identity that last modified the resource.",
+ "enum": [
+ "User",
+ "Application",
+ "ManagedIdentity",
+ "Key"
+ ],
+ "x-ms-enum": {
+ "name": "createdByType",
+ "modelAsString": true
+ }
+ },
+ "lastModifiedAt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The type of identity that last modified the resource."
+ }
+ }
+ },
+ "DppTrackedResourceList": {
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DppWorkerRequest": {
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ },
+ "headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "supportedGroupVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cultureInfo": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "httpMethod": {
+ "type": "string"
+ }
+ }
+ },
+ "Error": {
+ "description": "The resource management error response.",
+ "properties": {
+ "additionalInfo": {
+ "description": "The error additional info.",
+ "items": {
+ "$ref": "#/definitions/ErrorAdditionalInfo"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "code": {
+ "description": "The error code.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "details": {
+ "description": "The error details.",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "message": {
+ "description": "The error message.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "target": {
+ "description": "The error target.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ErrorAdditionalInfo": {
+ "description": "The resource management error additional info.",
+ "properties": {
+ "info": {
+ "description": "The additional info.",
+ "readOnly": true,
+ "type": "object"
+ },
+ "type": {
+ "description": "The additional info type.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ExportJobsResult": {
+ "description": "The result for export jobs containing blob details.",
+ "properties": {
+ "blobUrl": {
+ "description": "URL of the blob into which the serialized string of list of jobs is exported.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "blobSasKey": {
+ "description": "SAS key to access the blob.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobUrl": {
+ "description": "URL of the blob into which the ExcelFile is uploaded.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobSasKey": {
+ "description": "SAS key to access the ExcelFile blob.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "title": "ExportJobsResult",
+ "type": "object"
+ },
+ "FeatureSettings": {
+ "description": "Class containing feature settings of vault",
+ "type": "object",
+ "properties": {
+ "crossSubscriptionRestoreSettings": {
+ "$ref": "#/definitions/CrossSubscriptionRestoreSettings"
+ }
+ }
+ },
+ "FeatureValidationRequest": {
+ "description": "Base class for feature object",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "featureName": {
+ "description": "backup support feature name.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationRequest"
+ },
+ "FeatureValidationRequestBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "FeatureValidationResponse": {
+ "description": "Feature Validation Response",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "features": {
+ "description": "Response features",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SupportedFeature"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationResponse"
+ },
+ "FeatureValidationResponseBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ImmediateCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Immediate copy Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "ImmediateCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "ImmediateCopyOption"
+ },
+ "InnerError": {
+ "description": "Inner Error",
+ "properties": {
+ "additionalInfo": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Any Key value pairs that can be provided to the client for additional verbose information.",
+ "type": "object"
+ },
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "embeddedInnerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Child Inner Error, to allow Nesting."
+ }
+ },
+ "title": "InnerError",
+ "type": "object"
+ },
+ "ItemLevelRestoreCriteria": {
+ "description": "Class to contain criteria for item level restore",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ItemLevelRestoreTargetInfo": {
+ "description": "Restore target info for Item level restore operation",
+ "required": [
+ "restoreCriteria",
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "properties": {
+ "restoreCriteria": {
+ "description": "Restore Criteria",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ },
+ "x-ms-identifiers": []
+ },
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo"
+ },
+ "JobExtendedInfo": {
+ "description": "Extended Information about the job",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Job's Additional Details"
+ },
+ "backupInstanceState": {
+ "description": "State of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataTransferredInBytes": {
+ "description": "Number of bytes transferred",
+ "format": "double",
+ "readOnly": true,
+ "type": "number"
+ },
+ "recoveryDestination": {
+ "description": "Destination where restore is done",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Source Recovery Point",
+ "readOnly": true
+ },
+ "subTasks": {
+ "description": "List of Sub Tasks of the job",
+ "items": {
+ "$ref": "#/definitions/JobSubTask"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "targetRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Target Recovery Point",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "JobSubTask": {
+ "description": "Details of Job's Sub Task",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Additional details of Sub Tasks"
+ },
+ "taskId": {
+ "description": "Task Id of the Sub Task",
+ "format": "int32",
+ "type": "integer"
+ },
+ "taskName": {
+ "description": "Name of the Sub Task",
+ "type": "string"
+ },
+ "taskProgress": {
+ "description": "Progress of the Sub Task",
+ "readOnly": true,
+ "type": "string"
+ },
+ "taskStatus": {
+ "description": "Status of the Sub Task",
+ "type": "string"
+ }
+ },
+ "required": [
+ "taskId",
+ "taskName",
+ "taskStatus"
+ ],
+ "type": "object"
+ },
+ "MonitoringSettings": {
+ "type": "object",
+ "description": "Monitoring Settings",
+ "properties": {
+ "azureMonitorAlertSettings": {
+ "$ref": "#/definitions/AzureMonitorAlertSettings"
+ }
+ }
+ },
+ "OperationExtendedInfo": {
+ "description": "Operation Extended Info",
+ "properties": {
+ "objectType": {
+ "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.",
+ "type": "string"
+ }
+ },
+ "title": "OperationExtendedInfo",
+ "discriminator": "objectType",
+ "type": "object",
+ "required": [
+ "objectType"
+ ]
+ },
+ "OperationJobExtendedInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/OperationExtendedInfo"
+ }
+ ],
+ "description": "Operation Job Extended Info",
+ "properties": {
+ "jobId": {
+ "description": "Arm Id of the job created for this operation.",
+ "type": "string"
+ }
+ },
+ "title": "OperationJobExtendedInfo",
+ "type": "object",
+ "x-ms-discriminator-value": "OperationJobExtendedInfo"
+ },
+ "OperationResource": {
+ "description": "Operation Resource",
+ "properties": {
+ "endTime": {
+ "description": "End time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
+ },
+ "id": {
+ "description": "It should match what is used to GET the operation result",
+ "type": "string"
+ },
+ "name": {
+ "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationExtendedInfo",
+ "description": "End time of the operation"
+ },
+ "startTime": {
+ "description": "Start time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "title": "OperationResource",
+ "type": "object"
+ },
+ "PatchBackupVaultInput": {
+ "description": "Backup Vault Contract for Patch Backup Vault API.",
+ "type": "object",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ },
+ "featureSettings": {
+ "$ref": "#/definitions/FeatureSettings",
+ "description": "Feature Settings"
+ }
+ }
+ },
+ "PatchResourceRequestInput": {
+ "description": "Patch Request content for Microsoft.DataProtection resources",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ },
+ "properties": {
+ "$ref": "#/definitions/PatchBackupVaultInput",
+ "description": "Resource properties."
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ }
+ },
+ "title": "PatchResourceRequestInput",
+ "type": "object"
+ },
+ "PatchResourceGuardInput": {
+ "description": "Patch Request content for Microsoft.DataProtection Resource Guard resources",
+ "properties": {
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource Guard tags.",
+ "type": "object"
+ }
+ },
+ "title": "PatchResourceGuardInput",
+ "type": "object"
+ },
+ "PolicyInfo": {
+ "description": "Policy Info in backupInstance",
+ "properties": {
+ "policyId": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyParameters": {
+ "$ref": "#/definitions/PolicyParameters",
+ "description": "Policy parameters for the backup instance"
+ }
+ },
+ "required": [
+ "policyId"
+ ],
+ "title": "PolicyInfo",
+ "type": "object"
+ },
+ "PolicyParameters": {
+ "description": "Parameters in Policy",
+ "type": "object",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ],
+ "properties": {
+ "dataStoreParametersList": {
+ "description": "Gets or sets the DataStore Parameters",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataStoreParameters"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ProtectionStatusDetails": {
+ "description": "Protection status details",
+ "properties": {
+ "errorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection status error of the resource"
+ },
+ "status": {
+ "description": "Specifies the protection status of the resource",
+ "enum": [
+ "ConfiguringProtection",
+ "ConfiguringProtectionFailed",
+ "ProtectionConfigured",
+ "ProtectionStopped",
+ "SoftDeleted",
+ "SoftDeleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Status"
+ }
+ }
+ },
+ "title": "ProtectionStatusDetails",
+ "type": "object"
+ },
+ "RangeBasedItemLevelRestoreCriteria": {
+ "description": "Item Level target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "minMatchingValue": {
+ "description": "minimum value for range prefix match",
+ "type": "string"
+ },
+ "maxMatchingValue": {
+ "description": "maximum value for range prefix match",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria"
+ },
+ "KubernetesStorageClassRestoreCriteria": {
+ "description": "Item Level kubernetes storage class target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "selectedStorageClassName": {
+ "description": "Selected storage class name",
+ "type": "string"
+ },
+ "provisioner": {
+ "description": "Provisioner of the storage class",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesStorageClassRestoreCriteria"
+ },
+ "KubernetesPVRestoreCriteria": {
+ "description": "Item Level kubernetes persistent volume target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "name": {
+ "description": "Selected persistent volume claim name",
+ "type": "string"
+ },
+ "storageClassName": {
+ "description": "Selected storage class name for restore operation",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesPVRestoreCriteria"
+ },
+ "RecoveryPointDataStoreDetails": {
+ "description": "RecoveryPoint datastore details",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "expiryTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "metaData": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "visible": {
+ "type": "boolean"
+ },
+ "rehydrationExpiryTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ },
+ "rehydrationStatus": {
+ "readOnly": true,
+ "enum": [
+ "CREATE_IN_PROGRESS",
+ "COMPLETED",
+ "DELETE_IN_PROGRESS",
+ "DELETED",
+ "FAILED"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationStatus"
+ }
+ }
+ },
+ "title": "RecoveryPointDataStoreDetails",
+ "type": "object"
+ },
+ "RehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "enum": [
+ "Invalid",
+ "High",
+ "Standard"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationPriority"
+ }
+ },
+ "RestoreFilesTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore as files target parameters",
+ "properties": {
+ "targetDetails": {
+ "$ref": "#/definitions/TargetDetails",
+ "description": "Destination of RestoreAsFiles operation, when destination is not a datasource"
+ }
+ },
+ "required": [
+ "recoveryOption",
+ "targetDetails"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreFilesTargetInfo"
+ },
+ "RestoreJobRecoveryPointDetails": {
+ "properties": {
+ "recoveryPointID": {
+ "type": "string"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RestoreTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore target parameters",
+ "properties": {
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "required": [
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreTargetInfo"
+ },
+ "RestoreTargetInfoBase": {
+ "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "recoveryOption": {
+ "description": "Recovery Option",
+ "enum": [
+ "FailIfExists"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RecoveryOption"
+ }
+ },
+ "restoreLocation": {
+ "description": "Target Restore region",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "recoveryOption"
+ ],
+ "type": "object"
+ },
+ "ResourceMoveDetails": {
+ "description": "ResourceMoveDetails will be returned in response to GetResource call from ARM",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "CorrelationId of latest ResourceMove operation attempted",
+ "type": "string"
+ },
+ "startTimeUtc": {
+ "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "completionTimeUtc": {
+ "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "sourceResourcePath": {
+ "description": "ARM resource path of source resource",
+ "type": "string"
+ },
+ "targetResourcePath": {
+ "description": "ARM resource path of target resource used in latest ResourceMove operation",
+ "type": "string"
+ }
+ }
+ },
+ "RestorableTimeRange": {
+ "required": [
+ "startTime",
+ "endTime"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "Start time for the available restore range",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the available restore range",
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "RetentionTag": {
+ "description": "Retention tag",
+ "properties": {
+ "eTag": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Retention Tag Name to relate it to retention rule.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "tagName"
+ ],
+ "title": "RetentionTag",
+ "type": "object"
+ },
+ "ScheduleBasedBackupCriteria": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupCriteria"
+ }
+ ],
+ "description": "Schedule based backup criteria",
+ "properties": {
+ "absoluteCriteria": {
+ "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum",
+ "items": {
+ "enum": [
+ "AllBackup",
+ "FirstOfDay",
+ "FirstOfMonth",
+ "FirstOfWeek",
+ "FirstOfYear"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "AbsoluteMarker"
+ }
+ },
+ "type": "array"
+ },
+ "daysOfMonth": {
+ "description": "This is day of the month from 1 to 28 other wise last of month",
+ "items": {
+ "$ref": "#/definitions/Day"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "daysOfTheWeek": {
+ "description": "It should be Sunday/Monday/T..../Saturday",
+ "items": {
+ "enum": [
+ "Friday",
+ "Monday",
+ "Saturday",
+ "Sunday",
+ "Thursday",
+ "Tuesday",
+ "Wednesday"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DayOfWeek"
+ }
+ },
+ "type": "array"
+ },
+ "monthsOfYear": {
+ "description": "It should be January/February/....../December",
+ "items": {
+ "enum": [
+ "April",
+ "August",
+ "December",
+ "February",
+ "January",
+ "July",
+ "June",
+ "March",
+ "May",
+ "November",
+ "October",
+ "September"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Month"
+ }
+ },
+ "type": "array"
+ },
+ "scheduleTimes": {
+ "description": "List of schedule times for backup",
+ "items": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "weeksOfTheMonth": {
+ "description": "It should be First/Second/Third/Fourth/Last",
+ "items": {
+ "enum": [
+ "First",
+ "Fourth",
+ "Last",
+ "Second",
+ "Third"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "WeekNumber"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "ScheduleBasedBackupCriteria",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedBackupCriteria"
+ },
+ "ScheduleBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Schedule based trigger context",
+ "properties": {
+ "schedule": {
+ "$ref": "#/definitions/BackupSchedule",
+ "description": "Schedule for this backup"
+ },
+ "taggingCriteria": {
+ "description": "List of tags that can be applicable for given schedule.",
+ "items": {
+ "$ref": "#/definitions/TaggingCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType",
+ "schedule",
+ "taggingCriteria"
+ ],
+ "title": "ScheduleBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedTriggerContext"
+ },
+ "SecretStoreBasedAuthCredentials": {
+ "description": "Secret store based authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AuthCredentials"
+ }
+ ],
+ "properties": {
+ "secretStoreResource": {
+ "$ref": "#/definitions/SecretStoreResource",
+ "description": "Secret store resource"
+ }
+ },
+ "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials"
+ },
+ "SecretStoreResource": {
+ "description": "Class representing a secret store resource.",
+ "required": [
+ "secretStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "uri": {
+ "description": "Uri to get to the resource",
+ "type": "string"
+ },
+ "secretStoreType": {
+ "description": "Gets or sets the type of secret store",
+ "enum": [
+ "Invalid",
+ "AzureKeyVault"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SecretStoreType",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "Gets or sets value stored in secret store resource",
+ "type": "string"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "Class containing security settings of vault",
+ "type": "object",
+ "properties": {
+ "softDeleteSettings": {
+ "$ref": "#/definitions/SoftDeleteSettings"
+ },
+ "immutabilitySettings": {
+ "$ref": "#/definitions/ImmutabilitySettings"
+ }
+ }
+ },
+ "SoftDeleteSettings": {
+ "description": "Soft delete related settings",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "State of soft delete",
+ "enum": [
+ "Off",
+ "On",
+ "AlwaysOn"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SoftDeleteState",
+ "modelAsString": true,
+ "values": [
+ {
+ "description": "Soft Delete is turned off for the BackupVault",
+ "value": "Off"
+ },
+ {
+ "description": "Soft Delete is enabled for the BackupVault but can be turned off",
+ "value": "On"
+ },
+ {
+ "description": "Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed",
+ "value": "AlwaysOn"
+ }
+ ]
+ }
+ },
+ "retentionDurationInDays": {
+ "description": "Soft delete retention duration",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "SourceLifeCycle": {
+ "description": "Source LifeCycle",
+ "properties": {
+ "deleteAfter": {
+ "$ref": "#/definitions/DeleteOption"
+ },
+ "sourceDataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "targetDataStoreCopySettings": {
+ "items": {
+ "$ref": "#/definitions/TargetCopySetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "deleteAfter",
+ "sourceDataStore"
+ ],
+ "title": "SourceLifeCycle",
+ "type": "object"
+ },
+ "StorageSetting": {
+ "description": "Storage setting",
+ "properties": {
+ "datastoreType": {
+ "description": "Gets or sets the type of the datastore.",
+ "enum": [
+ "ArchiveStore",
+ "OperationalStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingStoreTypes"
+ }
+ },
+ "type": {
+ "description": "Gets or sets the type.",
+ "enum": [
+ "GeoRedundant",
+ "LocallyRedundant",
+ "ZoneRedundant"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingTypes"
+ }
+ }
+ },
+ "title": "StorageSetting",
+ "type": "object"
+ },
+ "SupportedFeature": {
+ "description": "Elements class for feature request",
+ "type": "object",
+ "properties": {
+ "featureName": {
+ "description": "support feature type.",
+ "type": "string"
+ },
+ "supportStatus": {
+ "description": "feature support status",
+ "enum": [
+ "Invalid",
+ "NotSupported",
+ "AlphaPreview",
+ "PrivatePreview",
+ "PublicPreview",
+ "GenerallyAvailable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureSupportStatus",
+ "modelAsString": true
+ }
+ },
+ "exposureControlledFeatures": {
+ "description": "support feature type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SyncBackupInstanceRequest": {
+ "description": "Sync BackupInstance Request",
+ "type": "object",
+ "properties": {
+ "syncType": {
+ "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases",
+ "enum": [
+ "Default",
+ "ForceResync"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TaggingCriteria": {
+ "description": "Tagging criteria",
+ "properties": {
+ "criteria": {
+ "description": "Criteria which decides whether the tag can be applied to a triggered backup.",
+ "items": {
+ "$ref": "#/definitions/BackupCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isDefault": {
+ "description": "Specifies if tag is default.",
+ "type": "boolean"
+ },
+ "taggingPriority": {
+ "description": "Retention Tag priority.",
+ "format": "int64",
+ "type": "integer"
+ },
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "required": [
+ "isDefault",
+ "tagInfo",
+ "taggingPriority"
+ ],
+ "title": "TaggingCriteria",
+ "type": "object"
+ },
+ "TargetCopySetting": {
+ "description": "Target copy settings",
+ "properties": {
+ "copyAfter": {
+ "$ref": "#/definitions/CopyOption",
+ "description": "It can be CustomCopyOption or ImmediateCopyOption."
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase",
+ "description": "Info of target datastore"
+ }
+ },
+ "required": [
+ "copyAfter",
+ "dataStore"
+ ],
+ "title": "TargetCopySetting",
+ "type": "object"
+ },
+ "TargetDetails": {
+ "description": "Class encapsulating target details, used where the destination is not a datasource",
+ "properties": {
+ "filePrefix": {
+ "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them",
+ "type": "string"
+ },
+ "restoreTargetLocationType": {
+ "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}",
+ "enum": [
+ "Invalid",
+ "AzureBlobs",
+ "AzureFiles"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreTargetLocationType",
+ "modelAsString": true
+ }
+ },
+ "url": {
+ "description": "Url denoting the restore destination. It can point to container / file share etc",
+ "type": "string"
+ },
+ "targetResourceArmId": {
+ "description": "Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share\r\nThis is optional if the target subscription can be identified with the URL field. If not\r\nthen this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states",
+ "type": "string"
+ }
+ },
+ "required": [
+ "filePrefix",
+ "restoreTargetLocationType",
+ "url"
+ ],
+ "type": "object"
+ },
+ "TriggerBackupRequest": {
+ "description": "Trigger backup request",
+ "properties": {
+ "backupRuleOptions": {
+ "$ref": "#/definitions/AdHocBackupRuleOptions",
+ "description": "Name for the Rule of the Policy which needs to be applied for this backup"
+ }
+ },
+ "required": [
+ "backupRuleOptions"
+ ],
+ "title": "TriggerBackupRequest",
+ "type": "object"
+ },
+ "TriggerContext": {
+ "description": "Trigger context",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "TriggerContext",
+ "type": "object"
+ },
+ "UserFacingError": {
+ "description": "Error object used by layers that have access to localized content, and propagate that to user",
+ "properties": {
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "details": {
+ "description": "Additional related Errors",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "innerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Inner Error"
+ },
+ "isRetryable": {
+ "description": "Whether the operation will be retryable or not",
+ "type": "boolean"
+ },
+ "isUserError": {
+ "description": "Whether the operation is due to a user error or service error",
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Any key value pairs that can be injected inside error object",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "recommendedAction": {
+ "description": "RecommendedAction � localized.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "target": {
+ "description": "Target of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ValidateForBackupRequest": {
+ "description": "Validate for backup request",
+ "properties": {
+ "backupInstance": {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ },
+ "required": [
+ "backupInstance"
+ ],
+ "title": "ValidateForBackupRequest",
+ "type": "object"
+ },
+ "ValidateRestoreRequestObject": {
+ "description": "Validate restore request object",
+ "properties": {
+ "restoreRequestObject": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest",
+ "description": "Gets or sets the restore request object."
+ }
+ },
+ "required": [
+ "restoreRequestObject"
+ ],
+ "title": "ValidateRestoreRequestObject",
+ "type": "object"
+ },
+ "ResourceGuard": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "allowAutoApprovals": {
+ "description": "This flag indicates whether auto approval is allowed or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "resourceGuardOperations": {
+ "description": "{readonly} List of operation details those are protected by the ResourceGuard resource",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardOperation"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "vaultCriticalOperationExclusionList": {
+ "description": "List of critical operations which are not protected by this resourceGuard",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Description about the pre-req steps to perform all the critical operations.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardOperation": {
+ "description": "This class contains all the details about a critical operation.",
+ "type": "object",
+ "properties": {
+ "vaultCriticalOperation": {
+ "description": "Name of the critical operation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requestResourceType": {
+ "description": "Type of resource request.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppBaseTrackedResource"
+ }
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ResourceGuard",
+ "description": "ResourceGuardResource properties"
+ }
+ }
+ },
+ "ResourceGuardResourceList": {
+ "description": "List of ResourceGuard resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionId": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "The subscription Id.",
+ "required": true,
+ "type": "string"
+ },
+ "ResourceGroupName": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "The name of the resource group where the backup vault is present.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "VaultName": {
+ "name": "vaultName",
+ "in": "path",
+ "description": "The name of the backup vault.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersion": {
+ "name": "api-version",
+ "in": "query",
+ "description": "Client Api Version.",
+ "required": true,
+ "type": "string"
+ },
+ "BackupInstanceName": {
+ "name": "backupInstanceName",
+ "in": "path",
+ "description": "The name of the backup instance.",
+ "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."
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/DeleteBackupInstance.json
new file mode 100644
index 000000000000..85005549b57e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/DeleteBackupInstance.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "backupInstanceName": "testInstance1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "204": {},
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
new file mode 100644
index 000000000000..5e2482ebc6d2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "Blob-Backup",
+ "vaultName": "ZBlobBackupVaultBVTD3",
+ "backupInstanceName": "zblobbackuptestsa58",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "sourceDataStoreType": "OperationalStore",
+ "startTime": "2020-10-17T23:28:17.6829685Z",
+ "endTime": "2021-02-24T00:35:17.6829685Z"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "zblobbackuptestsa58",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges",
+ "properties": {
+ "restorableTimeRanges": [
+ {
+ "startTime": "2021-02-23T18:33:51.6349708Z",
+ "endTime": "2021-02-24T00:35:17.0000000Z",
+ "objectType": "RestorableTimeRange"
+ }
+ ],
+ "objectType": "AzureBackupFindRestorableTimeRangesResponse"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstance.json
new file mode 100644
index 000000000000..533d50231c85
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstance.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
new file mode 100644
index 000000000000..66f1d7a160fb
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "backupInstanceName": "testInstance1",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "ConfiguringProtection"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetRecoveryPoint.json
new file mode 100644
index 000000000000..ffbc87bc1d90
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/GetRecoveryPoint.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListBackupInstances.json
new file mode 100644
index 000000000000..2d7beac55ba5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListBackupInstances.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
new file mode 100644
index 000000000000..5ab9f7743082
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "expiryTime": "2023-03-01T13:00:00Z",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/PutBackupInstance.json
new file mode 100644
index 000000000000..0ad8586d9208
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/PutBackupInstance.json
@@ -0,0 +1,167 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "validationType": "ShallowValidation"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ },
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeBackups.json
new file mode 100644
index 000000000000..5b51fe456df1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeProtection.json
new file mode 100644
index 000000000000..5b51fe456df1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ResumeProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/StopProtection.json
new file mode 100644
index 000000000000..5b51fe456df1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/StopProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SuspendBackups.json
new file mode 100644
index 000000000000..5b51fe456df1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SuspendBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SyncBackupInstance.json
new file mode 100644
index 000000000000..009623fdf7a2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/SyncBackupInstance.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "syncType": "Default"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerBackup.json
new file mode 100644
index 000000000000..f66612f361d6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerBackup.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupRuleOptions": {
+ "ruleName": "BackupWeekly",
+ "triggerOption": {
+ "retentionTagOverride": "yearly"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRehydrate.json
new file mode 100644
index 000000000000..bad65923220d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRehydrate.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestore.json
new file mode 100644
index 000000000000..cc4aa7662a9b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestore.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
new file mode 100644
index 000000000000..d2f4b478b72a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "targetDetails": {
+ "url": "https://teststorage.blob.core.windows.net/restoretest",
+ "filePrefix": "restoredblob",
+ "restoreTargetLocationType": "AzureBlobs"
+ },
+ "restoreLocation": "southeastasia",
+ "recoveryOption": "FailIfExists",
+ "objectType": "RestoreFilesTargetInfo"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
new file mode 100644
index 000000000000..5d1423f86835
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRestoreWithRehydrationRequest",
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateForBackup.json
new file mode 100644
index 000000000000..2b0cce73e693
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateForBackup.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupInstance": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateRestore.json
new file mode 100644
index 000000000000..d2ace7178757
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/BackupInstanceOperations/ValidateRestore.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "restoreRequestObject": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/CheckfeatureSupport.json
new file mode 100644
index 000000000000..2f50d21c6f69
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/CheckfeatureSupport.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "featureType": "DataSourceType",
+ "objectType": "FeatureValidationRequest"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "featureType": "DataSourceType",
+ "features": [
+ {
+ "featureName": "Microsoft.Storage/storageAccounts/blobServices",
+ "supportStatus": "PrivatePreview",
+ "exposureControlledFeatures": []
+ },
+ {
+ "featureName": "Microsoft.DBforPostgreSQL/servers/databases",
+ "supportStatus": "PublicPreview",
+ "exposureControlledFeatures": []
+ }
+ ],
+ "objectType": "FeatureValidationResponse"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
new file mode 100644
index 000000000000..eefafd6fb07e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
new file mode 100644
index 000000000000..31caac0e1543
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
new file mode 100644
index 000000000000..5b51fe456df1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationResult.json
new file mode 100644
index 000000000000..c091bddaaf64
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationResult.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatus.json
new file mode 100644
index 000000000000..4cdfb259f5ee
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatus.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusRGContext.json
new file mode 100644
index 000000000000..f2380f371144
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusRGContext.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusVaultContext.json
new file mode 100644
index 000000000000..4465dfd0387e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/GetOperationStatusVaultContext.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetExportJobsOperationResult.json
new file mode 100644
index 000000000000..a9d4e5b1ec43
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetExportJobsOperationResult.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "operationId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000",
+ "blobSasKey": "someKey",
+ "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx",
+ "excelFileBlobSasKey": "someKey"
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": 60,
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetJob.json
new file mode 100644
index 000000000000..9341b2ffdee5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/GetJob.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap",
+ "extendedInfo": {
+ "subTasks": [
+ {
+ "taskId": 1,
+ "taskName": "Trigger Backup",
+ "taskStatus": "Started"
+ }
+ ],
+ "additionalDetails": {
+ "RetentionTag": "Default",
+ "PolicyRuleName": "BackupWeekly",
+ "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"
+ }
+ }
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/ListJobs.json
new file mode 100644
index 000000000000..d81f8ce117af
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/ListJobs.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4",
+ "policyName": "jakavetPolicy2",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb4",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T05:00:08.1746833Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002",
+ "name": "8989416e-7573-4836-8cf1-0e90954f1002",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5",
+ "policyName": "jakavetPolicy3",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb5",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T18:00:03.6660733Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3",
+ "policyName": "jakavetPolicy1",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb3",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T11:11:50.5595259Z",
+ "endTime": "2021-03-17T11:14:02.5319646Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Succeeded",
+ "isUserTriggered": true,
+ "supportedActions": [
+ ""
+ ],
+ "duration": "00:02:11.9724387",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097",
+ "name": "43252662-1b43-44fd-a856-0055665cb097",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/TriggerExportJobs.json
new file mode 100644
index 000000000000..9bb02501d8b9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/JobCRUD/TriggerExportJobs.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-12-01",
+ "Retry-After": 60
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/Operations/List.json
new file mode 100644
index 000000000000..1322b6ab26bc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/Operations/List.json
@@ -0,0 +1,533 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataProtection/locations/getBackupStatus/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Status",
+ "operation": "Check Backup Status for Vault",
+ "description": "Check Backup Status for Recovery Services Vaults"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Create a Backup Instance",
+ "description": "Creates a Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Delete Backup Instance",
+ "description": "Deletes the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instance Details",
+ "description": "Returns details of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instances",
+ "description": "Returns all Backup Instances"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Backup Backup Instance",
+ "description": "Performs Backup on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Sync Backup Instance",
+ "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Stop Protection of Backup Instance",
+ "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Suspend Backups of Backup Instance",
+ "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Protection of Backup Instance",
+ "description": "Resume protection of a ProtectionStopped BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Backups of Backup Instance",
+ "description": "Resume Backups for a BackupsSuspended BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Validate for Restore of Backup Instance",
+ "description": "Validates for Restore of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Restore Backup Instance",
+ "description": "Triggers restore on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Create Backup Policy",
+ "description": "Creates Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Delete Backup Policy",
+ "description": "Deletes the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policy details",
+ "description": "Returns details of the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policies",
+ "description": "Returns all Backup Policies"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get the list of ResourceGuard proxies for a resource",
+ "description": "Get the list of ResourceGuard proxies for a resource"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get ResourceGuard proxy",
+ "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Create ResourceGuard proxy",
+ "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Delete ResourceGuard proxy",
+ "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation",
+ "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Point Details",
+ "description": "Returns details of the Recovery Point"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Points",
+ "description": "Returns all Recovery Points"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Restorable Time Ranges",
+ "operation": "Find Restorable Time Ranges",
+ "description": "Finds Restorable Time Ranges"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Operation Result of a Patch Operation for a Backup Vault",
+ "description": "Gets Operation Result of a Patch Operation for a Backup Vault"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/checkNameAvailability/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Check if the requested BackupVault Name is Available",
+ "description": "Checks if the requested BackupVault Name is Available"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Resource Group",
+ "description": "Gets list of Backup Vaults in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Subscription",
+ "description": "Gets list of Backup Vaults in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Create ResourceGuard",
+ "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard",
+ "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Delete ResourceGuard",
+ "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Resource Group",
+ "description": "Gets list of ResourceGuards in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Subscription",
+ "description": "Gets list of ResourceGuards in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Update ResourceGuard",
+ "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard operation request info",
+ "description": "Gets ResourceGuard operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard default operation request info",
+ "description": "Gets ResourceGuard default operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Validate if a feature is supported",
+ "description": "Validates if a feature is supported"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Results",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Validate Backup",
+ "operation": "Validate for backup of Backup Instance",
+ "description": "Validates for backup of Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Jobs",
+ "description": "Get Jobs list"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Job Object",
+ "description": "Get Job details"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/register/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Register Resource Provider",
+ "description": "Registers subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/unregister/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Unregister Resource Provider",
+ "description": "Unregisters subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/operations/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "List of Operations",
+ "description": "Operation returns the list of Operations for a Resource Provider"
+ },
+ "origin": "user"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
new file mode 100644
index 000000000000..1973b56f80a1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
@@ -0,0 +1,200 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/DeleteBackupPolicy.json
new file mode 100644
index 000000000000..06c5e1cfb69e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/DeleteBackupPolicy.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/GetBackupPolicy.json
new file mode 100644
index 000000000000..dacbbeab9f8b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/GetBackupPolicy.json
@@ -0,0 +1,109 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/ListBackupPolicy.json
new file mode 100644
index 000000000000..22540d4259f4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/PolicyCRUD/ListBackupPolicy.json
@@ -0,0 +1,112 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json
new file mode 100644
index 000000000000..21686fd5e689
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..bd6dd03a34d6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..4816bcf19a6a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..219308ed7f3f
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..61db02d8f3e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..7bdd91de686c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..191b2f74f3dc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuard.json
new file mode 100644
index 000000000000..e39727754ffc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuard.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "ResourceGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
new file mode 100644
index 000000000000..a4c322a4bd50
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
new file mode 100644
index 000000000000..4d79dd118834
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..40cdec833b4a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..ffa4572ff031
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..f07eb6bb1eb6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..118ac4da7fe3
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..a08654dca54d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..637a0c23c790
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
new file mode 100644
index 000000000000..f70fed857bad
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PutResourceGuard.json
new file mode 100644
index 000000000000..65603c1c4750
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/ResourceGuardCRUD/PutResourceGuard.json
@@ -0,0 +1,43 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
new file mode 100644
index 000000000000..b4b038b89e0d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "location": "westus",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "name": "swaggerExample"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/DeleteBackupVault.json
new file mode 100644
index 000000000000..68b2218b0ac2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/DeleteBackupVault.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {},
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVault.json
new file mode 100644
index 000000000000..a16a6c9fcc49
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVault.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultWithMSI.json
new file mode 100644
index 000000000000..6f17d343b6e5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultWithMSI.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
new file mode 100644
index 000000000000..0a5d0873c8e7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json
new file mode 100644
index 000000000000..11d2a831d2a5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetOperationResultPatch.json
new file mode 100644
index 000000000000..4c625311b49b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/GetOperationResultPatch.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ },
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Retry-After": "60"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PatchBackupVault.json
new file mode 100644
index 000000000000..da8db0a4120d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PatchBackupVault.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVault.json
new file mode 100644
index 000000000000..04f1ef604145
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVault.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVaultWithMSI.json
new file mode 100644
index 000000000000..415a54b486b6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-12-01/examples/VaultCRUD/PutBackupVaultWithMSI.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "systemAssigned"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-12-01"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
new file mode 100644
index 000000000000..715a2657a5d1
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
@@ -0,0 +1,7014 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2023-01-01",
+ "title": "DataProtectionBackupClient",
+ "x-ms-code-generation-settings": {
+ "internalConstructors": false
+ }
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a subscription.",
+ "operationId": "BackupVaults_GetInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in Subscription": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "GetOperationResult"
+ ],
+ "description": "Gets the operation result for a resource",
+ "operationId": "OperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets the operation status for a resource.",
+ "x-ms-examples": {
+ "Get OperationResult": {
+ "$ref": "./examples/GetOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for a resource.",
+ "operationId": "OperationStatus_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatus.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a BackupVault's context.",
+ "operationId": "OperationStatusBackupVaultContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusVaultContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}": {
+ "get": {
+ "tags": [
+ "OperationStatus"
+ ],
+ "summary": "Gets the operation status for an operation over a ResourceGroup's context.",
+ "operationId": "OperationStatusResourceGroupContext_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OperationResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get OperationStatus": {
+ "$ref": "./examples/GetOperationStatusRGContext.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns resource collection belonging to a resource group.",
+ "operationId": "BackupVaults_GetInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get BackupVaults in ResourceGroup": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": {
+ "get": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Returns a resource belonging to a resource group.",
+ "operationId": "BackupVaults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupVault": {
+ "$ref": "./examples/VaultCRUD/GetBackupVault.json"
+ },
+ "Get BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Creates or updates a BackupVault resource belonging to a resource group.",
+ "operationId": "BackupVaults_CreateOrUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupVault": {
+ "$ref": "./examples/VaultCRUD/PutBackupVault.json"
+ },
+ "Create BackupVault With MSI": {
+ "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Deletes a BackupVault resource from the resource group.",
+ "operationId": "BackupVaults_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupVault": {
+ "$ref": "./examples/VaultCRUD/DeleteBackupVault.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "BackupVaults_Update",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceRequestInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Patch BackupVault": {
+ "$ref": "./examples/VaultCRUD/PatchBackupVault.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "BackupVaultOperationResults_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupVaultResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetOperationResult Patch": {
+ "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": {
+ "post": {
+ "tags": [
+ "BackupVaults"
+ ],
+ "summary": "API to check for resource name availability",
+ "operationId": "BackupVaults_CheckNameAvailability",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "description": "The location in which uniqueness will be verified.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Check name availability request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CheckNameAvailabilityResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check BackupVaults name availability": {
+ "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": {
+ "post": {
+ "tags": [
+ "DppFeatureSupport"
+ ],
+ "summary": "Validates if a feature is supported",
+ "operationId": "DataProtection_CheckFeatureSupport",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Feature support request object",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Check Azure Vm Backup Feature Support": {
+ "$ref": "./examples/CheckfeatureSupport.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.DataProtection/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "description": "Returns the list of available operations.",
+ "operationId": "DataProtectionOperations_List",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ClientDiscoveryResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink",
+ "itemName": "value"
+ },
+ "x-ms-examples": {
+ "Returns the list of supported REST operations.": {
+ "$ref": "./examples/Operations/List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "description": "Returns list of backup policies belonging to a backup vault",
+ "operationId": "BackupPolicies_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": {
+ "get": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Get",
+ "description": "Gets a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "summary": "Gets a backup policy belonging to a backup vault",
+ "x-ms-examples": {
+ "Get BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_CreateOrUpdate",
+ "summary": "Creates or Updates a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "description": "Name of the policy",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CreateOrUpdate BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "BackupPolicies"
+ ],
+ "operationId": "BackupPolicies_Delete",
+ "summary": "Deletes a backup policy belonging to a backup vault",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupPolicy": {
+ "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instances belonging to a backup vault",
+ "operationId": "BackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List BackupInstances in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Gets a backup instance with name in a backup vault",
+ "operationId": "BackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Create or update a backup instance in a backup vault",
+ "operationId": "BackupInstances_CreateOrUpdate",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Delete a backup instance in a backup vault",
+ "operationId": "BackupInstances_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "200": {
+ "description": "Ok"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Trigger adhoc backup ",
+ "operationId": "BackupInstances_AdhocBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TriggerBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Trigger Adhoc Backup": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validate whether adhoc backup will be successful or not",
+ "operationId": "BackupInstances_ValidateForBackup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateForBackupRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Validate For Backup": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}": {
+ "get": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Get result of backup instance creation operation",
+ "operationId": "BackupInstances_GetBackupInstanceOperationResult",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get BackupInstanceOperationResult": {
+ "$ref": "./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Returns a list of Recovery Points for a DataSource in a vault.",
+ "operationId": "RecoveryPoints_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "OData filter options.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "skipToken Filter.",
+ "required": false,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/RecoveryPointsFilters",
+ "x-ms-examples": {
+ "List Recovery Points in a Vault": {
+ "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": {
+ "get": {
+ "tags": [
+ "RecoveryPoint"
+ ],
+ "description": "Gets a Recovery Point using recoveryPointId for a Datasource.",
+ "operationId": "RecoveryPoints_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "recoveryPointId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Recovery Point": {
+ "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": {
+ "post": {
+ "description": "rehydrate recovery point for restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRehydrate",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "description": "Request body for operation",
+ "in": "body",
+ "name": "parameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRehydrationRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "tags": [
+ "BackupInstances"
+ ],
+ "x-ms-examples": {
+ "Trigger Rehydrate": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Triggers restore for a BackupInstance",
+ "operationId": "BackupInstances_TriggerRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Trigger Restore": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json"
+ },
+ "Trigger Restore As Files": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json"
+ },
+ "Trigger Restore With Rehydration": {
+ "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume backups for backup instance",
+ "operationId": "BackupInstances_ResumeBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeBackups": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will resume protection for a stopped backup instance",
+ "operationId": "BackupInstances_ResumeProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "ResumeProtection": {
+ "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop protection of a backup instance and data will be held forever",
+ "operationId": "BackupInstances_StopProtection",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "StopProtection": {
+ "$ref": "./examples/BackupInstanceOperations/StopProtection.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)",
+ "operationId": "BackupInstances_SuspendBackups",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "SuspendBackups": {
+ "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state",
+ "operationId": "BackupInstances_SyncBackupInstance",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SyncBackupInstanceRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Sync BackupInstance": {
+ "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": {
+ "post": {
+ "tags": [
+ "BackupInstances"
+ ],
+ "description": "Validates if Restore can be triggered for a DataSource",
+ "operationId": "BackupInstances_ValidateForRestore",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateRestoreRequestObject"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Contains additional information like job Id",
+ "schema": {
+ "$ref": "#/definitions/OperationJobExtendedInfo"
+ }
+ },
+ "202": {
+ "description": "The operation will be completed asynchronously.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Azure-AsyncOperation": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Validate Restore": {
+ "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": {
+ "get": {
+ "tags": [
+ "AzureBackupJobs"
+ ],
+ "description": "Returns list of jobs belonging to a backup vault",
+ "operationId": "Jobs_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get Jobs": {
+ "$ref": "./examples/JobCRUD/ListJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": {
+ "post": {
+ "tags": [
+ "FindRestorableTimeRanges"
+ ],
+ "operationId": "RestorableTimeRanges_Find",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "$ref": "#/parameters/BackupInstanceName"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Find Restorable Time Ranges": {
+ "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets a job with id in a backup vault",
+ "operationId": "Jobs_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "jobId",
+ "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Job": {
+ "$ref": "./examples/JobCRUD/GetJob.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": {
+ "post": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Triggers export of jobs and returns an OperationID to track.",
+ "operationId": "ExportJobs_Trigger",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted",
+ "headers": {
+ "Location": {
+ "description": "The URL of the resource used to check the status of the asynchronous operation.",
+ "type": "string"
+ },
+ "Retry-After": {
+ "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.",
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "x-ms-examples": {
+ "Trigger Export Jobs": {
+ "$ref": "./examples/JobCRUD/TriggerExportJobs.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "AzureBackupJob"
+ ],
+ "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.",
+ "operationId": "ExportJobsOperationResult_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "operationId",
+ "description": "OperationID which represents the export job.",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ExportJobsResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Export Jobs Operation Result": {
+ "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets deleted backup instances belonging to a backup vault",
+ "operationId": "DeletedBackupInstances_List",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List DeletedBackupInstances in a Vault": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}": {
+ "get": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "description": "Gets a deleted backup instance with name in a backup vault",
+ "operationId": "DeletedBackupInstances_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DeletedBackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete": {
+ "post": {
+ "tags": [
+ "DeletedBackupInstances"
+ ],
+ "operationId": "DeletedBackupInstances_Undelete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/VaultName"
+ },
+ {
+ "name": "backupInstanceName",
+ "description": "The name of the deleted backup instance",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Undelete Deleted BackupInstance": {
+ "$ref": "./examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a subscription.",
+ "operationId": "ResourceGuards_GetResourcesInSubscription",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in Subscription": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns ResourceGuards collection belonging to a ResourceGroup.",
+ "operationId": "ResourceGuards_GetResourcesInResourceGroup",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get ResourceGuards in ResourceGroup": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}": {
+ "put": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Creates or updates a ResourceGuard resource belonging to a resource group.",
+ "operationId": "ResourceGuards_Put",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PutResourceGuard.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns a ResourceGuard belonging to a resource group.",
+ "operationId": "ResourceGuards_Get",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/GetResourceGuard.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Deletes a ResourceGuard resource from the resource group.",
+ "operationId": "ResourceGuards_Delete",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "NoContent"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/DeleteResourceGuard.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.",
+ "operationId": "ResourceGuards_Patch",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "The name of ResourceGuard",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Request body for operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PatchResourceGuardInput"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch ResourceGuard": {
+ "$ref": "./examples/ResourceGuardCRUD/PatchResourceGuard.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDisableSoftDeleteRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetBackupSecurityPINRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDeleteProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetUpdateProtectedItemRequestsObjects",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResourceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List OperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}": {
+ "get": {
+ "tags": [
+ "ResourceGuards"
+ ],
+ "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.",
+ "operationId": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGuardsName",
+ "in": "path",
+ "description": "",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get DefaultOperationsRequestObject": {
+ "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AbsoluteDeleteOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeleteOption"
+ }
+ ],
+ "description": "Delete option with duration",
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "AbsoluteDeleteOption",
+ "type": "object",
+ "x-ms-discriminator-value": "AbsoluteDeleteOption"
+ },
+ "RecoveryPointsFilters": {
+ "type": "object",
+ "properties": {
+ "restorePointDataStoreId": {
+ "type": "string"
+ },
+ "isVisible": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "type": "string"
+ },
+ "endDate": {
+ "type": "string"
+ },
+ "extendedInfo": {
+ "type": "boolean"
+ },
+ "restorePointState": {
+ "type": "string"
+ }
+ }
+ },
+ "AdHocBackupRuleOptions": {
+ "description": "Adhoc backup rules",
+ "properties": {
+ "ruleName": {
+ "type": "string"
+ },
+ "triggerOption": {
+ "$ref": "#/definitions/AdhocBackupTriggerOption"
+ }
+ },
+ "required": [
+ "ruleName",
+ "triggerOption"
+ ],
+ "title": "AdHocBackupRuleOptions",
+ "type": "object"
+ },
+ "AdhocBackupTriggerOption": {
+ "description": "Adhoc backup trigger option",
+ "properties": {
+ "retentionTagOverride": {
+ "type": "string"
+ }
+ },
+ "title": "AdhocBackupTriggerOption",
+ "type": "object"
+ },
+ "AdhocBasedTaggingCriteria": {
+ "description": "Adhoc backup tagging criteria",
+ "properties": {
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "title": "AdhocBasedTaggingCriteria",
+ "type": "object"
+ },
+ "AdhocBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Adhoc trigger context",
+ "properties": {
+ "taggingCriteria": {
+ "$ref": "#/definitions/AdhocBasedTaggingCriteria",
+ "description": "Tagging Criteria containing retention tag for adhoc backup."
+ }
+ },
+ "required": [
+ "objectType",
+ "taggingCriteria"
+ ],
+ "title": "AdhocBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "AdhocBasedTriggerContext"
+ },
+ "AuthCredentials": {
+ "description": "Base class for different types of authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "AzureBackupDiscreteRecoveryPoint": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint"
+ }
+ ],
+ "description": "Azure backup discrete RecoveryPoint",
+ "properties": {
+ "friendlyName": {
+ "type": "string"
+ },
+ "recoveryPointDataStoresDetails": {
+ "items": {
+ "$ref": "#/definitions/RecoveryPointDataStoreDetails"
+ },
+ "type": "array"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "policyName": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "type": "string"
+ },
+ "recoveryPointId": {
+ "type": "string"
+ },
+ "recoveryPointType": {
+ "type": "string"
+ },
+ "retentionTagName": {
+ "type": "string"
+ },
+ "retentionTagVersion": {
+ "type": "string"
+ },
+ "expiryTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupDiscreteRecoveryPoint",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint"
+ },
+ "AzureBackupFindRestorableTimeRangesRequest": {
+ "description": "List Restore Ranges Request",
+ "required": [
+ "sourceDataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreSourceDataStoreType",
+ "modelAsString": true
+ }
+ },
+ "startTime": {
+ "description": "Start time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the List Restore Ranges request. ISO 8601 format.",
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesRequestResource": {
+ "description": "List Restore Ranges Request",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppWorkerRequest"
+ }
+ ],
+ "properties": {
+ "content": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest",
+ "description": "AzureBackupFindRestorableTimeRangesRequestResource content"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponse": {
+ "description": "List Restore Ranges Response",
+ "type": "object",
+ "properties": {
+ "restorableTimeRanges": {
+ "description": "Returns the Restore Ranges available on the Backup Instance.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RestorableTimeRange"
+ },
+ "x-ms-identifiers": []
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "AzureBackupFindRestorableTimeRangesResponseResource": {
+ "description": "List Restore Ranges Response",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse",
+ "description": "AzureBackupFindRestorableTimeRangesResponseResource properties"
+ }
+ }
+ },
+ "AzureBackupJob": {
+ "description": "AzureBackup Job Class",
+ "properties": {
+ "activityID": {
+ "description": "Job Activity Id",
+ "type": "string"
+ },
+ "backupInstanceFriendlyName": {
+ "description": "Name of the Backup Instance",
+ "type": "string"
+ },
+ "backupInstanceId": {
+ "description": "ARM ID of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "ARM ID of the DataSource",
+ "type": "string"
+ },
+ "dataSourceLocation": {
+ "description": "Location of the DataSource",
+ "type": "string"
+ },
+ "dataSourceName": {
+ "description": "User Friendly Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceSetName": {
+ "description": "Data Source Set Name of the DataSource",
+ "type": "string"
+ },
+ "dataSourceType": {
+ "description": "Type of DataSource",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Total run time of the job. ISO 8601 format.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "EndTime of the job(in UTC)",
+ "format": "date-time",
+ "readOnly": true,
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "A List, detailing the errors related to the job",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "extendedInfo": {
+ "$ref": "#/definitions/JobExtendedInfo",
+ "description": "Extended Information about the job",
+ "readOnly": true
+ },
+ "isUserTriggered": {
+ "description": "Indicated that whether the job is adhoc(true) or scheduled(false)",
+ "type": "boolean"
+ },
+ "operation": {
+ "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure",
+ "type": "string"
+ },
+ "operationCategory": {
+ "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management",
+ "type": "string"
+ },
+ "policyId": {
+ "description": "ARM ID of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyName": {
+ "description": "Name of the policy",
+ "readOnly": true,
+ "type": "string"
+ },
+ "progressEnabled": {
+ "description": "Indicated whether progress is enabled for the job",
+ "type": "boolean"
+ },
+ "progressUrl": {
+ "description": "Url which contains job's progress",
+ "readOnly": true,
+ "type": "string"
+ },
+ "restoreType": {
+ "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceResourceGroup": {
+ "description": "Resource Group Name of the Datasource",
+ "type": "string"
+ },
+ "sourceSubscriptionID": {
+ "description": "SubscriptionId corresponding to the DataSource",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "StartTime of the job(in UTC)",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning",
+ "type": "string"
+ },
+ "subscriptionId": {
+ "description": "Subscription Id of the corresponding backup vault",
+ "type": "string"
+ },
+ "supportedActions": {
+ "description": "List of supported actions",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "vaultName": {
+ "description": "Name of the vault",
+ "type": "string"
+ },
+ "etag": {
+ "type": "string"
+ },
+ "sourceDataStoreName": {
+ "type": "string"
+ },
+ "destinationDataStoreName": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "activityID",
+ "subscriptionId",
+ "dataSourceId",
+ "vaultName",
+ "backupInstanceFriendlyName",
+ "sourceResourceGroup",
+ "dataSourceName",
+ "progressEnabled",
+ "sourceSubscriptionID",
+ "dataSourceLocation",
+ "startTime",
+ "dataSourceType",
+ "operationCategory",
+ "operation",
+ "status",
+ "isUserTriggered",
+ "supportedActions"
+ ],
+ "type": "object"
+ },
+ "AzureBackupJobResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "AzureBackup Job Resource Class",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupJob",
+ "description": "AzureBackupJobResource properties",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupJobResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of AzureBackup Job resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupJobResource"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AzureBackupParams": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupParameters"
+ }
+ ],
+ "description": "Azure backup parameters",
+ "properties": {
+ "backupType": {
+ "description": "BackupType ; Full/Incremental etc",
+ "type": "string"
+ }
+ },
+ "required": [
+ "backupType",
+ "objectType"
+ ],
+ "title": "AzureBackupParams",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupParams"
+ },
+ "AzureBackupRecoveryPoint": {
+ "description": "Azure backup recoveryPoint",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "AzureBackupRecoveryPoint",
+ "type": "object"
+ },
+ "AzureBackupRecoveryPointBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "Azure backup recoveryPoint based restore request",
+ "properties": {
+ "recoveryPointId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId"
+ ],
+ "title": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest"
+ },
+ "AzureBackupRecoveryPointResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AzureBackupRecoveryPoint",
+ "description": "AzureBackupRecoveryPointResource properties"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResource"
+ },
+ "AzureBackupRecoveryPointResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "Azure backup recoveryPoint resource list",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/AzureBackupRecoveryPointResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "AzureBackupRecoveryPointResourceList",
+ "type": "object"
+ },
+ "AzureBackupRehydrationRequest": {
+ "description": "Azure Backup Rehydrate Request",
+ "properties": {
+ "recoveryPointId": {
+ "description": "Id of the recovery point to be recovered",
+ "type": "string"
+ },
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointId",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRehydrationRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreRequest": {
+ "description": "Azure backup restore request",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "type": "string"
+ },
+ "restoreTargetInfo": {
+ "$ref": "#/definitions/RestoreTargetInfoBase",
+ "description": "Gets or sets the restore target information."
+ },
+ "sourceDataStoreType": {
+ "description": "Gets or sets the type of the source data store.",
+ "enum": [
+ "ArchiveStore",
+ "SnapshotStore",
+ "OperationalStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "SourceDataStoreType"
+ }
+ },
+ "sourceResourceId": {
+ "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "restoreTargetInfo",
+ "sourceDataStoreType"
+ ],
+ "title": "AzureBackupRestoreRequest",
+ "type": "object"
+ },
+ "AzureBackupRestoreWithRehydrationRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup Restore with Rehydration Request",
+ "properties": {
+ "rehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "$ref": "#/definitions/RehydrationPriority"
+ },
+ "rehydrationRetentionDuration": {
+ "description": "Retention duration in ISO 8601 format i.e P10D .",
+ "type": "string"
+ }
+ },
+ "required": [
+ "rehydrationPriority",
+ "rehydrationRetentionDuration"
+ ],
+ "title": "AzureBackupRestoreWithRehydrationRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest"
+ },
+ "AzureBackupRecoveryTimeBasedRestoreRequest": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/AzureBackupRestoreRequest"
+ }
+ ],
+ "description": "AzureBackup RecoveryPointTime Based Restore Request",
+ "properties": {
+ "recoveryPointTime": {
+ "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recoveryPointTime"
+ ],
+ "title": "AzureBackupRecoveryTimeBasedRestoreRequest",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest"
+ },
+ "AzureBackupRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure backup rule",
+ "properties": {
+ "backupParameters": {
+ "$ref": "#/definitions/BackupParameters"
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "trigger": {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ },
+ "required": [
+ "dataStore",
+ "name",
+ "objectType",
+ "trigger"
+ ],
+ "title": "AzureBackupRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureBackupRule"
+ },
+ "AzureMonitorAlertSettings": {
+ "type": "object",
+ "description": "Settings for Azure Monitor based alerts",
+ "properties": {
+ "alertsForAllJobFailures": {
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AlertsState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "AzureOperationalStoreParameters": {
+ "description": "Parameters for Operational-Tier DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DataStoreParameters"
+ }
+ ],
+ "properties": {
+ "resourceGroupId": {
+ "description": "Gets or sets the Snapshot Resource Group Uri.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "AzureOperationalStoreParameters"
+ },
+ "KubernetesClusterBackupDatasourceParameters": {
+ "description": "Parameters for Kubernetes Cluster Backup Datasource",
+ "required": [
+ "snapshotVolumes",
+ "includeClusterScopeResources"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ }
+ ],
+ "properties": {
+ "snapshotVolumes": {
+ "description": "Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during restore.",
+ "type": "boolean"
+ },
+ "includeClusterScopeResources": {
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.",
+ "type": "boolean"
+ },
+ "includedNamespaces": {
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedNamespaces": {
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedResourceTypes": {
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedResourceTypes": {
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "labelSelectors": {
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesClusterBackupDatasourceParameters"
+ },
+ "BlobBackupDatasourceParameters": {
+ "description": "Parameters to be used during configuration of backup of blobs",
+ "required": [
+ "containersList",
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ }
+ ],
+ "properties": {
+ "containersList": {
+ "description": "List of containers to be backed up during configuration of backup of blobs",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "BlobBackupDatasourceParameters"
+ },
+ "AzureRetentionRule": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BasePolicyRule"
+ }
+ ],
+ "description": "Azure retention rule",
+ "properties": {
+ "isDefault": {
+ "type": "boolean"
+ },
+ "lifecycles": {
+ "items": {
+ "$ref": "#/definitions/SourceLifeCycle"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "lifecycles",
+ "name",
+ "objectType"
+ ],
+ "title": "AzureRetentionRule",
+ "type": "object",
+ "x-ms-discriminator-value": "AzureRetentionRule"
+ },
+ "BackupCriteria": {
+ "description": "BackupCriteria base class",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupCriteria",
+ "type": "object"
+ },
+ "BackupInstance": {
+ "description": "Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo",
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "friendlyName": {
+ "description": "Gets or sets the Backup Instance friendly name.",
+ "type": "string"
+ },
+ "dataSourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Gets or sets the data source information."
+ },
+ "dataSourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Gets or sets the data source set information."
+ },
+ "policyInfo": {
+ "$ref": "#/definitions/PolicyInfo",
+ "description": "Gets or sets the policy information."
+ },
+ "protectionStatus": {
+ "$ref": "#/definitions/ProtectionStatusDetails",
+ "description": "Specifies the protection status of the resource",
+ "readOnly": true
+ },
+ "currentProtectionState": {
+ "description": "Specifies the current protection state of the resource",
+ "enum": [
+ "Invalid",
+ "NotProtected",
+ "ConfiguringProtection",
+ "ProtectionConfigured",
+ "BackupSchedulesSuspended",
+ "RetentionSchedulesSuspended",
+ "ProtectionStopped",
+ "ProtectionError",
+ "ConfiguringProtectionFailed",
+ "SoftDeleting",
+ "SoftDeleted",
+ "UpdatingProtection"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CurrentProtectionState",
+ "modelAsString": true
+ }
+ },
+ "protectionErrorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection error of the resource",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed",
+ "type": "string",
+ "readOnly": true
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ },
+ "validationType": {
+ "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.",
+ "enum": [
+ "ShallowValidation",
+ "DeepValidation"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidationType",
+ "modelAsString": true
+ }
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "BackupInstanceResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppProxyResource"
+ }
+ ],
+ "description": "BackupInstance Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupInstance",
+ "description": "BackupInstanceResource properties"
+ }
+ },
+ "title": "BackupInstanceResource"
+ },
+ "BackupInstanceResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "BackupInstance Resource list response",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupInstanceResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupInstanceResourceList",
+ "type": "object"
+ },
+ "BackupParameters": {
+ "description": "BackupParameters base",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "BackupParameters",
+ "type": "object"
+ },
+ "BackupPolicy": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BaseBackupPolicy"
+ }
+ ],
+ "description": "Rule based backup policy",
+ "properties": {
+ "policyRules": {
+ "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc",
+ "items": {
+ "$ref": "#/definitions/BasePolicyRule"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "policyRules"
+ ],
+ "title": "BackupPolicy",
+ "type": "object",
+ "x-ms-discriminator-value": "BackupPolicy"
+ },
+ "BackupSchedule": {
+ "description": "Schedule for backup",
+ "properties": {
+ "repeatingTimeIntervals": {
+ "description": "ISO 8601 repeating time interval format",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "timeZone": {
+ "description": "Time zone for a schedule. Example: Pacific Standard Time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "repeatingTimeIntervals"
+ ],
+ "title": "BackupSchedule",
+ "type": "object"
+ },
+ "BackupVault": {
+ "description": "Backup Vault",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "readOnly": true,
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "ProvisioningState"
+ }
+ },
+ "resourceMoveState": {
+ "description": "Resource move state for backup vault",
+ "enum": [
+ "Unknown",
+ "InProgress",
+ "PrepareFailed",
+ "CommitFailed",
+ "Failed",
+ "PrepareTimedout",
+ "CommitTimedout",
+ "CriticalFailure",
+ "PartialSuccess",
+ "MoveSucceeded"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ResourceMoveState",
+ "modelAsString": true
+ }
+ },
+ "resourceMoveDetails": {
+ "$ref": "#/definitions/ResourceMoveDetails",
+ "description": "Resource move details for backup vault",
+ "readOnly": true
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ },
+ "storageSettings": {
+ "description": "Storage Settings",
+ "items": {
+ "$ref": "#/definitions/StorageSetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isVaultProtectedByResourceGuard": {
+ "description": "Is vault protected by resource guard",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "featureSettings": {
+ "$ref": "#/definitions/FeatureSettings",
+ "description": "Feature Settings"
+ }
+ },
+ "required": [
+ "storageSettings"
+ ],
+ "title": "BackupVault",
+ "type": "object"
+ },
+ "BackupVaultResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResource"
+ }
+ ],
+ "description": "Backup Vault Resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BackupVault",
+ "description": "BackupVaultResource properties"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "title": "BackupVault Resource"
+ },
+ "BackupVaultResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BackupVault resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BackupVaultResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BackupVaultResourceList",
+ "type": "object"
+ },
+ "BaseBackupPolicy": {
+ "description": "BackupPolicy base",
+ "discriminator": "objectType",
+ "properties": {
+ "datasourceTypes": {
+ "description": "Type of datasource for the backup management",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "datasourceTypes",
+ "objectType"
+ ],
+ "title": "BaseBackupPolicy",
+ "type": "object"
+ },
+ "BaseBackupPolicyResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "description": "BaseBackupPolicy resource",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/BaseBackupPolicy",
+ "description": "BaseBackupPolicyResource properties"
+ }
+ },
+ "title": "BaseBackupPolicyResource"
+ },
+ "BaseBackupPolicyResourceList": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "description": "List of BaseBackupPolicy resources",
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "items": {
+ "$ref": "#/definitions/BaseBackupPolicyResource"
+ },
+ "type": "array"
+ }
+ },
+ "title": "BaseBackupPolicyResourceList",
+ "type": "object"
+ },
+ "BasePolicyRule": {
+ "description": "BasePolicy Rule",
+ "discriminator": "objectType",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "objectType"
+ ],
+ "title": "BasePolicyRule",
+ "type": "object"
+ },
+ "CheckNameAvailabilityRequest": {
+ "description": "CheckNameAvailability Request",
+ "properties": {
+ "name": {
+ "description": "Resource name for which availability needs to be checked",
+ "type": "string"
+ },
+ "type": {
+ "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityRequest",
+ "type": "object"
+ },
+ "CheckNameAvailabilityResult": {
+ "description": "CheckNameAvailability Result",
+ "properties": {
+ "message": {
+ "description": "Gets or sets the message.",
+ "type": "string"
+ },
+ "nameAvailable": {
+ "description": "Gets or sets a value indicating whether [name available].",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "Gets or sets the reason.",
+ "type": "string"
+ }
+ },
+ "title": "CheckNameAvailabilityResult",
+ "type": "object"
+ },
+ "ClientDiscoveryDisplay": {
+ "description": "Localized display information of an operation.",
+ "properties": {
+ "description": {
+ "description": "Description of the operation having details of what operation is about.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operations Name itself.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Name of the provider for display purposes",
+ "type": "string"
+ },
+ "resource": {
+ "description": "ResourceType for which this Operation can be performed.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryDisplay",
+ "type": "object"
+ },
+ "ClientDiscoveryForLogSpecification": {
+ "description": "Class to represent shoebox log specification in json client discovery.",
+ "properties": {
+ "blobDuration": {
+ "description": "blob duration of shoebox log specification",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name for shoebox log specification.",
+ "type": "string"
+ }
+ },
+ "title": "ClientDiscoveryForLogSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryForProperties": {
+ "description": "Class to represent shoebox properties in json client discovery.",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ClientDiscoveryForServiceSpecification",
+ "description": "Operation properties."
+ }
+ },
+ "title": "ClientDiscoveryForProperties",
+ "type": "object"
+ },
+ "ClientDiscoveryForServiceSpecification": {
+ "description": "Class to represent shoebox service specification in json client discovery.",
+ "properties": {
+ "logSpecifications": {
+ "description": "List of log specifications of this operation.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryForLogSpecification"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryForServiceSpecification",
+ "type": "object"
+ },
+ "ClientDiscoveryResponse": {
+ "description": "Operations List response which contains list of available APIs.",
+ "properties": {
+ "nextLink": {
+ "description": "Link to the next chunk of Response.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of available operations.",
+ "items": {
+ "$ref": "#/definitions/ClientDiscoveryValueForSingleApi"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "title": "ClientDiscoveryResponse",
+ "type": "object"
+ },
+ "ClientDiscoveryValueForSingleApi": {
+ "description": "Available operation details.",
+ "properties": {
+ "display": {
+ "$ref": "#/definitions/ClientDiscoveryDisplay",
+ "description": "Contains the localized display information for this particular operation"
+ },
+ "name": {
+ "description": "Name of the Operation.",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ },
+ "origin": {
+ "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/ClientDiscoveryForProperties",
+ "description": "Properties for the given operation."
+ }
+ },
+ "title": "ClientDiscoveryValueForSingleApi",
+ "type": "object"
+ },
+ "CloudError": {
+ "description": "An error response from Azure Backup.",
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "title": "CloudError",
+ "x-ms-external": true
+ },
+ "CopyOnExpiryOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Copy on Expiry Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOnExpiryOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CopyOnExpiryOption"
+ },
+ "CopyOption": {
+ "description": "Options to copy",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CopyOption",
+ "type": "object"
+ },
+ "CrossSubscriptionRestoreSettings": {
+ "description": "CrossSubscriptionRestore Settings",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "CrossSubscriptionRestore state",
+ "enum": [
+ "Disabled",
+ "PermanentlyDisabled",
+ "Enabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CrossSubscriptionRestoreState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "CustomCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Duration based custom options to copy",
+ "properties": {
+ "duration": {
+ "description": "Data copied after given timespan",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "CustomCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "CustomCopyOption"
+ },
+ "Datasource": {
+ "description": "Datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "Datasource",
+ "type": "object"
+ },
+ "DatasourceSet": {
+ "description": "DatasourceSet details of datasource to be backed up",
+ "properties": {
+ "datasourceType": {
+ "description": "DatasourceType of the resource.",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "resourceID": {
+ "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.",
+ "type": "string"
+ },
+ "resourceLocation": {
+ "description": "Location of datasource.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Unique identifier of the resource in the context of parent.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Resource Type of Datasource.",
+ "type": "string"
+ },
+ "resourceUri": {
+ "description": "Uri of the resource.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "resourceID"
+ ],
+ "title": "DatasourceSet",
+ "type": "object"
+ },
+ "DataStoreInfoBase": {
+ "description": "DataStoreInfo base",
+ "properties": {
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DataStoreTypes"
+ }
+ },
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "readOnly": false,
+ "type": "string"
+ }
+ },
+ "required": [
+ "dataStoreType",
+ "objectType"
+ ],
+ "title": "DataStoreInfoBase",
+ "type": "object"
+ },
+ "DataStoreParameters": {
+ "description": "Parameters for DataStore",
+ "required": [
+ "objectType",
+ "dataStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ },
+ "dataStoreType": {
+ "description": "type of datastore; Operational/Vault/Archive",
+ "enum": [
+ "OperationalStore",
+ "VaultStore",
+ "ArchiveStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DataStoreTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "BackupDatasourceParameters": {
+ "description": "Parameters for Backup Datasource",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "Day": {
+ "description": "Day of the week",
+ "properties": {
+ "date": {
+ "description": "Date of the month",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isLast": {
+ "description": "Whether Date is last date of month",
+ "type": "boolean"
+ }
+ },
+ "title": "Day",
+ "type": "object"
+ },
+ "DeletedBackupInstance": {
+ "description": "Deleted Backup Instance",
+ "required": [
+ "dataSourceInfo",
+ "policyInfo"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ ],
+ "properties": {
+ "deletionInfo": {
+ "$ref": "#/definitions/DeletionInfo",
+ "description": "Deletion info of Backup Instance",
+ "readOnly": true
+ }
+ }
+ },
+ "DeletedBackupInstanceResource": {
+ "description": "Deleted Backup Instance",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/DeletedBackupInstance",
+ "description": "DeletedBackupInstanceResource properties"
+ }
+ }
+ },
+ "DeletedBackupInstanceResourceList": {
+ "description": "List of DeletedBackupInstance resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeletedBackupInstanceResource"
+ }
+ }
+ }
+ },
+ "DeletionInfo": {
+ "description": "Deletion Info",
+ "type": "object",
+ "properties": {
+ "deletionTime": {
+ "description": "Specifies time of deletion",
+ "type": "string",
+ "readOnly": true
+ },
+ "billingEndDate": {
+ "description": "Specifies billing end date",
+ "type": "string",
+ "readOnly": true
+ },
+ "scheduledPurgeTime": {
+ "description": "Specifies purge time",
+ "type": "string",
+ "readOnly": true
+ },
+ "deleteActivityID": {
+ "description": "Delete activity ID for troubleshooting purpose",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DeleteOption": {
+ "description": "Delete Option",
+ "discriminator": "objectType",
+ "properties": {
+ "duration": {
+ "description": "Duration of deletion after given timespan",
+ "type": "string"
+ },
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "duration",
+ "objectType"
+ ],
+ "title": "DeleteOption",
+ "type": "object"
+ },
+ "DppIdentityDetails": {
+ "description": "Identity details",
+ "properties": {
+ "principalId": {
+ "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "The identityType which can be either SystemAssigned or None",
+ "type": "string"
+ }
+ },
+ "title": "DppIdentityDetails",
+ "type": "object"
+ },
+ "DppBaseResourceList": {
+ "description": "Base for all lists of V2 resources.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Dpp resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DppBaseResource"
+ }
+ },
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "DppBaseResource": {
+ "type": "object",
+ "description": "Base resource under Microsoft.DataProtection provider namespace",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DppResource": {
+ "description": "Resource class",
+ "properties": {
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData"
+ }
+ },
+ "title": "DppResource",
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppResourceList": {
+ "description": "ListResource",
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "title": "List Resource",
+ "type": "object"
+ },
+ "DppBaseTrackedResource": {
+ "properties": {
+ "eTag": {
+ "description": "Optional ETag.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "Resource location.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ },
+ "type": {
+ "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppTrackedResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppBaseTrackedResource"
+ }
+ ],
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "ImmutabilitySettings": {
+ "description": "Immutability Settings at vault level",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "Immutability state",
+ "enum": [
+ "Disabled",
+ "Unlocked",
+ "Locked"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ImmutabilityState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "DppProxyResource": {
+ "properties": {
+ "id": {
+ "description": "Proxy Resource Id represents the complete path to the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Proxy Resource name associated with the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Proxy Resource tags.",
+ "type": "object"
+ },
+ "systemData": {
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData"
+ }
+ },
+ "type": "object",
+ "x-ms-azure-resource": true
+ },
+ "DppTrackedResourceList": {
+ "properties": {
+ "nextLink": {
+ "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DppWorkerRequest": {
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ },
+ "headers": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "supportedGroupVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cultureInfo": {
+ "type": "string"
+ },
+ "parameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "httpMethod": {
+ "type": "string"
+ }
+ }
+ },
+ "Error": {
+ "description": "The resource management error response.",
+ "properties": {
+ "additionalInfo": {
+ "description": "The error additional info.",
+ "items": {
+ "$ref": "#/definitions/ErrorAdditionalInfo"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "code": {
+ "description": "The error code.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "details": {
+ "description": "The error details.",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "message": {
+ "description": "The error message.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "target": {
+ "description": "The error target.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ErrorAdditionalInfo": {
+ "description": "The resource management error additional info.",
+ "properties": {
+ "info": {
+ "description": "The additional info.",
+ "readOnly": true,
+ "type": "object"
+ },
+ "type": {
+ "description": "The additional info type.",
+ "readOnly": true,
+ "type": "string"
+ }
+ }
+ },
+ "ExportJobsResult": {
+ "description": "The result for export jobs containing blob details.",
+ "properties": {
+ "blobUrl": {
+ "description": "URL of the blob into which the serialized string of list of jobs is exported.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "blobSasKey": {
+ "description": "SAS key to access the blob.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobUrl": {
+ "description": "URL of the blob into which the ExcelFile is uploaded.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "excelFileBlobSasKey": {
+ "description": "SAS key to access the ExcelFile blob.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "title": "ExportJobsResult",
+ "type": "object"
+ },
+ "FeatureSettings": {
+ "description": "Class containing feature settings of vault",
+ "type": "object",
+ "properties": {
+ "crossSubscriptionRestoreSettings": {
+ "$ref": "#/definitions/CrossSubscriptionRestoreSettings"
+ }
+ }
+ },
+ "FeatureValidationRequest": {
+ "description": "Base class for feature object",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationRequestBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "featureName": {
+ "description": "backup support feature name.",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationRequest"
+ },
+ "FeatureValidationRequestBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "FeatureValidationResponse": {
+ "description": "Feature Validation Response",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/FeatureValidationResponseBase"
+ }
+ ],
+ "properties": {
+ "featureType": {
+ "description": "backup support feature type.",
+ "enum": [
+ "Invalid",
+ "DataSourceType"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureType",
+ "modelAsString": true
+ }
+ },
+ "features": {
+ "description": "Response features",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SupportedFeature"
+ },
+ "x-ms-identifiers": []
+ }
+ },
+ "x-ms-discriminator-value": "FeatureValidationResponse"
+ },
+ "FeatureValidationResponseBase": {
+ "description": "Base class for Backup Feature support",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string",
+ "readOnly": false
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ImmediateCopyOption": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/CopyOption"
+ }
+ ],
+ "description": "Immediate copy Option",
+ "required": [
+ "objectType"
+ ],
+ "title": "ImmediateCopyOption",
+ "type": "object",
+ "x-ms-discriminator-value": "ImmediateCopyOption"
+ },
+ "InnerError": {
+ "description": "Inner Error",
+ "properties": {
+ "additionalInfo": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Any Key value pairs that can be provided to the client for additional verbose information.",
+ "type": "object"
+ },
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "embeddedInnerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Child Inner Error, to allow Nesting."
+ }
+ },
+ "title": "InnerError",
+ "type": "object"
+ },
+ "ItemLevelRestoreCriteria": {
+ "description": "Class to contain criteria for item level restore",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "discriminator": "objectType"
+ },
+ "ItemLevelRestoreTargetInfo": {
+ "description": "Restore target info for Item level restore operation",
+ "required": [
+ "restoreCriteria",
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "properties": {
+ "restoreCriteria": {
+ "description": "Restore Criteria",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ },
+ "x-ms-identifiers": []
+ },
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo"
+ },
+ "ItemPathBasedRestoreCriteria": {
+ "description": "Prefix criteria to be used to during restore",
+ "required": [
+ "itemPath",
+ "isPathRelativeToBackupItem",
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "itemPath": {
+ "description": "The path of the item to be restored. It could be the full path of the item or the path relative to the backup item",
+ "type": "string"
+ },
+ "isPathRelativeToBackupItem": {
+ "description": "Flag to specify if the path is relative to backup item or full path",
+ "type": "boolean"
+ },
+ "subItemPathPrefix": {
+ "description": "The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "ItemPathBasedRestoreCriteria"
+ },
+ "JobExtendedInfo": {
+ "description": "Extended Information about the job",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Job's Additional Details"
+ },
+ "backupInstanceState": {
+ "description": "State of the Backup Instance",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dataTransferredInBytes": {
+ "description": "Number of bytes transferred",
+ "format": "double",
+ "readOnly": true,
+ "type": "number"
+ },
+ "recoveryDestination": {
+ "description": "Destination where restore is done",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Source Recovery Point",
+ "readOnly": true
+ },
+ "subTasks": {
+ "description": "List of Sub Tasks of the job",
+ "items": {
+ "$ref": "#/definitions/JobSubTask"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true,
+ "type": "array"
+ },
+ "targetRecoverPoint": {
+ "$ref": "#/definitions/RestoreJobRecoveryPointDetails",
+ "description": "Details of the Target Recovery Point",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "JobSubTask": {
+ "description": "Details of Job's Sub Task",
+ "properties": {
+ "additionalDetails": {
+ "additionalProperties": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": "Additional details of Sub Tasks"
+ },
+ "taskId": {
+ "description": "Task Id of the Sub Task",
+ "format": "int32",
+ "type": "integer"
+ },
+ "taskName": {
+ "description": "Name of the Sub Task",
+ "type": "string"
+ },
+ "taskProgress": {
+ "description": "Progress of the Sub Task",
+ "readOnly": true,
+ "type": "string"
+ },
+ "taskStatus": {
+ "description": "Status of the Sub Task",
+ "type": "string"
+ }
+ },
+ "required": [
+ "taskId",
+ "taskName",
+ "taskStatus"
+ ],
+ "type": "object"
+ },
+ "MonitoringSettings": {
+ "type": "object",
+ "description": "Monitoring Settings",
+ "properties": {
+ "azureMonitorAlertSettings": {
+ "$ref": "#/definitions/AzureMonitorAlertSettings"
+ }
+ }
+ },
+ "OperationExtendedInfo": {
+ "description": "Operation Extended Info",
+ "properties": {
+ "objectType": {
+ "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.",
+ "type": "string"
+ }
+ },
+ "title": "OperationExtendedInfo",
+ "discriminator": "objectType",
+ "type": "object",
+ "required": [
+ "objectType"
+ ]
+ },
+ "OperationJobExtendedInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/OperationExtendedInfo"
+ }
+ ],
+ "description": "Operation Job Extended Info",
+ "properties": {
+ "jobId": {
+ "description": "Arm Id of the job created for this operation.",
+ "type": "string"
+ }
+ },
+ "title": "OperationJobExtendedInfo",
+ "type": "object",
+ "x-ms-discriminator-value": "OperationJobExtendedInfo"
+ },
+ "OperationResource": {
+ "description": "Operation Resource",
+ "properties": {
+ "endTime": {
+ "description": "End time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section."
+ },
+ "id": {
+ "description": "It should match what is used to GET the operation result",
+ "type": "string"
+ },
+ "name": {
+ "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/OperationExtendedInfo",
+ "description": "End time of the operation"
+ },
+ "startTime": {
+ "description": "Start time of the operation",
+ "format": "date-time",
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "title": "OperationResource",
+ "type": "object"
+ },
+ "PatchBackupVaultInput": {
+ "description": "Backup Vault Contract for Patch Backup Vault API.",
+ "type": "object",
+ "properties": {
+ "monitoringSettings": {
+ "$ref": "#/definitions/MonitoringSettings",
+ "description": "Monitoring Settings"
+ },
+ "securitySettings": {
+ "$ref": "#/definitions/SecuritySettings",
+ "description": "Security Settings"
+ },
+ "featureSettings": {
+ "$ref": "#/definitions/FeatureSettings",
+ "description": "Feature Settings"
+ }
+ }
+ },
+ "PatchResourceRequestInput": {
+ "description": "Patch Request content for Microsoft.DataProtection resources",
+ "properties": {
+ "identity": {
+ "$ref": "#/definitions/DppIdentityDetails",
+ "description": "Input Managed Identity Details"
+ },
+ "properties": {
+ "$ref": "#/definitions/PatchBackupVaultInput",
+ "description": "Resource properties."
+ },
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags.",
+ "type": "object"
+ }
+ },
+ "title": "PatchResourceRequestInput",
+ "type": "object"
+ },
+ "PatchResourceGuardInput": {
+ "description": "Patch Request content for Microsoft.DataProtection Resource Guard resources",
+ "properties": {
+ "tags": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource Guard tags.",
+ "type": "object"
+ }
+ },
+ "title": "PatchResourceGuardInput",
+ "type": "object"
+ },
+ "PolicyInfo": {
+ "description": "Policy Info in backupInstance",
+ "properties": {
+ "policyId": {
+ "type": "string"
+ },
+ "policyVersion": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "policyParameters": {
+ "$ref": "#/definitions/PolicyParameters",
+ "description": "Policy parameters for the backup instance"
+ }
+ },
+ "required": [
+ "policyId"
+ ],
+ "title": "PolicyInfo",
+ "type": "object"
+ },
+ "PolicyParameters": {
+ "description": "Parameters in Policy",
+ "type": "object",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ],
+ "properties": {
+ "dataStoreParametersList": {
+ "description": "Gets or sets the DataStore Parameters",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataStoreParameters"
+ },
+ "x-ms-identifiers": []
+ },
+ "backupDatasourceParametersList": {
+ "description": "Gets or sets the Backup Data Source Parameters",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BackupDatasourceParameters"
+ },
+ "x-ms-identifiers": []
+ }
+ }
+ },
+ "ProtectionStatusDetails": {
+ "description": "Protection status details",
+ "properties": {
+ "errorDetails": {
+ "$ref": "#/definitions/UserFacingError",
+ "description": "Specifies the protection status error of the resource"
+ },
+ "status": {
+ "description": "Specifies the protection status of the resource",
+ "enum": [
+ "ConfiguringProtection",
+ "ConfiguringProtectionFailed",
+ "ProtectionConfigured",
+ "ProtectionStopped",
+ "SoftDeleted",
+ "SoftDeleting"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Status"
+ }
+ }
+ },
+ "title": "ProtectionStatusDetails",
+ "type": "object"
+ },
+ "RangeBasedItemLevelRestoreCriteria": {
+ "description": "Item Level target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "minMatchingValue": {
+ "description": "minimum value for range prefix match",
+ "type": "string"
+ },
+ "maxMatchingValue": {
+ "description": "maximum value for range prefix match",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria"
+ },
+ "KubernetesStorageClassRestoreCriteria": {
+ "description": "Item Level kubernetes storage class target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "selectedStorageClassName": {
+ "description": "Selected storage class name",
+ "type": "string"
+ },
+ "provisioner": {
+ "description": "Provisioner of the storage class",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesStorageClassRestoreCriteria"
+ },
+ "KubernetesPVRestoreCriteria": {
+ "description": "Item Level kubernetes persistent volume target info for restore operation",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "name": {
+ "description": "Selected persistent volume claim name",
+ "type": "string"
+ },
+ "storageClassName": {
+ "description": "Selected storage class name for restore operation",
+ "type": "string"
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesPVRestoreCriteria"
+ },
+ "KubernetesClusterRestoreCriteria": {
+ "description": "kubernetes Cluster Backup target info for restore operation",
+ "required": [
+ "includeClusterScopeResources"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ItemLevelRestoreCriteria"
+ }
+ ],
+ "properties": {
+ "includeClusterScopeResources": {
+ "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.",
+ "type": "boolean"
+ },
+ "includedNamespaces": {
+ "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedNamespaces": {
+ "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedResourceTypes": {
+ "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "excludedResourceTypes": {
+ "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "labelSelectors": {
+ "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "persistentVolumeRestoreMode": {
+ "description": "Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.",
+ "enum": [
+ "RestoreWithVolumeData",
+ "RestoreWithoutVolumeData"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PersistentVolumeRestoreMode",
+ "modelAsString": true
+ }
+ },
+ "conflictPolicy": {
+ "description": "Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.",
+ "enum": [
+ "Skip",
+ "Patch"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ExistingResourcePolicy",
+ "modelAsString": true
+ }
+ },
+ "namespaceMappings": {
+ "description": "Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-discriminator-value": "KubernetesClusterRestoreCriteria"
+ },
+ "RecoveryPointDataStoreDetails": {
+ "description": "RecoveryPoint datastore details",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "expiryTime": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "metaData": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "visible": {
+ "type": "boolean"
+ },
+ "rehydrationExpiryTime": {
+ "format": "date-time",
+ "type": "string",
+ "readOnly": true
+ },
+ "rehydrationStatus": {
+ "readOnly": true,
+ "enum": [
+ "CREATE_IN_PROGRESS",
+ "COMPLETED",
+ "DELETE_IN_PROGRESS",
+ "DELETED",
+ "FAILED"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationStatus"
+ }
+ }
+ },
+ "title": "RecoveryPointDataStoreDetails",
+ "type": "object"
+ },
+ "RehydrationPriority": {
+ "description": "Priority to be used for rehydration. Values High or Standard",
+ "enum": [
+ "Invalid",
+ "High",
+ "Standard"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RehydrationPriority"
+ }
+ },
+ "RestoreFilesTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore as files target parameters",
+ "properties": {
+ "targetDetails": {
+ "$ref": "#/definitions/TargetDetails",
+ "description": "Destination of RestoreAsFiles operation, when destination is not a datasource"
+ }
+ },
+ "required": [
+ "recoveryOption",
+ "targetDetails"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreFilesTargetInfo"
+ },
+ "RestoreJobRecoveryPointDetails": {
+ "properties": {
+ "recoveryPointID": {
+ "type": "string"
+ },
+ "recoveryPointTime": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RestoreTargetInfo": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/RestoreTargetInfoBase"
+ }
+ ],
+ "description": "Class encapsulating restore target parameters",
+ "properties": {
+ "datasourceInfo": {
+ "$ref": "#/definitions/Datasource",
+ "description": "Information of target DS"
+ },
+ "datasourceSetInfo": {
+ "$ref": "#/definitions/DatasourceSet",
+ "description": "Information of target DS Set"
+ },
+ "datasourceAuthCredentials": {
+ "$ref": "#/definitions/AuthCredentials",
+ "description": "Credentials to use to authenticate with data source provider."
+ }
+ },
+ "required": [
+ "datasourceInfo",
+ "recoveryOption"
+ ],
+ "type": "object",
+ "x-ms-discriminator-value": "RestoreTargetInfo"
+ },
+ "RestoreTargetInfoBase": {
+ "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of Datasource object, used to initialize the right inherited type",
+ "type": "string"
+ },
+ "recoveryOption": {
+ "description": "Recovery Option",
+ "enum": [
+ "FailIfExists"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "RecoveryOption"
+ }
+ },
+ "restoreLocation": {
+ "description": "Target Restore region",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType",
+ "recoveryOption"
+ ],
+ "type": "object"
+ },
+ "ResourceMoveDetails": {
+ "description": "ResourceMoveDetails will be returned in response to GetResource call from ARM",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "CorrelationId of latest ResourceMove operation attempted",
+ "type": "string"
+ },
+ "startTimeUtc": {
+ "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "completionTimeUtc": {
+ "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.",
+ "type": "string"
+ },
+ "sourceResourcePath": {
+ "description": "ARM resource path of source resource",
+ "type": "string"
+ },
+ "targetResourcePath": {
+ "description": "ARM resource path of target resource used in latest ResourceMove operation",
+ "type": "string"
+ }
+ }
+ },
+ "RestorableTimeRange": {
+ "required": [
+ "startTime",
+ "endTime"
+ ],
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "Start time for the available restore range",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time for the available restore range",
+ "type": "string"
+ },
+ "objectType": {
+ "type": "string"
+ }
+ }
+ },
+ "RetentionTag": {
+ "description": "Retention tag",
+ "properties": {
+ "eTag": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Retention Tag version.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Retention Tag Name to relate it to retention rule.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "tagName"
+ ],
+ "title": "RetentionTag",
+ "type": "object"
+ },
+ "ScheduleBasedBackupCriteria": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/BackupCriteria"
+ }
+ ],
+ "description": "Schedule based backup criteria",
+ "properties": {
+ "absoluteCriteria": {
+ "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum",
+ "items": {
+ "enum": [
+ "AllBackup",
+ "FirstOfDay",
+ "FirstOfMonth",
+ "FirstOfWeek",
+ "FirstOfYear"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "AbsoluteMarker"
+ }
+ },
+ "type": "array"
+ },
+ "daysOfMonth": {
+ "description": "This is day of the month from 1 to 28 other wise last of month",
+ "items": {
+ "$ref": "#/definitions/Day"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "daysOfTheWeek": {
+ "description": "It should be Sunday/Monday/T..../Saturday",
+ "items": {
+ "enum": [
+ "Friday",
+ "Monday",
+ "Saturday",
+ "Sunday",
+ "Thursday",
+ "Tuesday",
+ "Wednesday"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "DayOfWeek"
+ }
+ },
+ "type": "array"
+ },
+ "monthsOfYear": {
+ "description": "It should be January/February/....../December",
+ "items": {
+ "enum": [
+ "April",
+ "August",
+ "December",
+ "February",
+ "January",
+ "July",
+ "June",
+ "March",
+ "May",
+ "November",
+ "October",
+ "September"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "Month"
+ }
+ },
+ "type": "array"
+ },
+ "scheduleTimes": {
+ "description": "List of schedule times for backup",
+ "items": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "weeksOfTheMonth": {
+ "description": "It should be First/Second/Third/Fourth/Last",
+ "items": {
+ "enum": [
+ "First",
+ "Fourth",
+ "Last",
+ "Second",
+ "Third"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "WeekNumber"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "ScheduleBasedBackupCriteria",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedBackupCriteria"
+ },
+ "ScheduleBasedTriggerContext": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/TriggerContext"
+ }
+ ],
+ "description": "Schedule based trigger context",
+ "properties": {
+ "schedule": {
+ "$ref": "#/definitions/BackupSchedule",
+ "description": "Schedule for this backup"
+ },
+ "taggingCriteria": {
+ "description": "List of tags that can be applicable for given schedule.",
+ "items": {
+ "$ref": "#/definitions/TaggingCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "objectType",
+ "schedule",
+ "taggingCriteria"
+ ],
+ "title": "ScheduleBasedTriggerContext",
+ "type": "object",
+ "x-ms-discriminator-value": "ScheduleBasedTriggerContext"
+ },
+ "SecretStoreBasedAuthCredentials": {
+ "description": "Secret store based authentication credentials.",
+ "required": [
+ "objectType"
+ ],
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/AuthCredentials"
+ }
+ ],
+ "properties": {
+ "secretStoreResource": {
+ "$ref": "#/definitions/SecretStoreResource",
+ "description": "Secret store resource"
+ }
+ },
+ "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials"
+ },
+ "SecretStoreResource": {
+ "description": "Class representing a secret store resource.",
+ "required": [
+ "secretStoreType"
+ ],
+ "type": "object",
+ "properties": {
+ "uri": {
+ "description": "Uri to get to the resource",
+ "type": "string"
+ },
+ "secretStoreType": {
+ "description": "Gets or sets the type of secret store",
+ "enum": [
+ "Invalid",
+ "AzureKeyVault"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SecretStoreType",
+ "modelAsString": true
+ }
+ },
+ "value": {
+ "description": "Gets or sets value stored in secret store resource",
+ "type": "string"
+ }
+ }
+ },
+ "SecuritySettings": {
+ "description": "Class containing security settings of vault",
+ "type": "object",
+ "properties": {
+ "softDeleteSettings": {
+ "$ref": "#/definitions/SoftDeleteSettings"
+ },
+ "immutabilitySettings": {
+ "$ref": "#/definitions/ImmutabilitySettings"
+ }
+ }
+ },
+ "SoftDeleteSettings": {
+ "description": "Soft delete related settings",
+ "type": "object",
+ "properties": {
+ "state": {
+ "description": "State of soft delete",
+ "enum": [
+ "Off",
+ "On",
+ "AlwaysOn"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SoftDeleteState",
+ "modelAsString": true,
+ "values": [
+ {
+ "description": "Soft Delete is turned off for the BackupVault",
+ "value": "Off"
+ },
+ {
+ "description": "Soft Delete is enabled for the BackupVault but can be turned off",
+ "value": "On"
+ },
+ {
+ "description": "Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed",
+ "value": "AlwaysOn"
+ }
+ ]
+ }
+ },
+ "retentionDurationInDays": {
+ "description": "Soft delete retention duration",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "SourceLifeCycle": {
+ "description": "Source LifeCycle",
+ "properties": {
+ "deleteAfter": {
+ "$ref": "#/definitions/DeleteOption"
+ },
+ "sourceDataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase"
+ },
+ "targetDataStoreCopySettings": {
+ "items": {
+ "$ref": "#/definitions/TargetCopySetting"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ }
+ },
+ "required": [
+ "deleteAfter",
+ "sourceDataStore"
+ ],
+ "title": "SourceLifeCycle",
+ "type": "object"
+ },
+ "StorageSetting": {
+ "description": "Storage setting",
+ "properties": {
+ "datastoreType": {
+ "description": "Gets or sets the type of the datastore.",
+ "enum": [
+ "ArchiveStore",
+ "OperationalStore",
+ "VaultStore"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingStoreTypes"
+ }
+ },
+ "type": {
+ "description": "Gets or sets the type.",
+ "enum": [
+ "GeoRedundant",
+ "LocallyRedundant",
+ "ZoneRedundant"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "modelAsString": true,
+ "name": "StorageSettingTypes"
+ }
+ }
+ },
+ "title": "StorageSetting",
+ "type": "object"
+ },
+ "SupportedFeature": {
+ "description": "Elements class for feature request",
+ "type": "object",
+ "properties": {
+ "featureName": {
+ "description": "support feature type.",
+ "type": "string"
+ },
+ "supportStatus": {
+ "description": "feature support status",
+ "enum": [
+ "Invalid",
+ "NotSupported",
+ "AlphaPreview",
+ "PrivatePreview",
+ "PublicPreview",
+ "GenerallyAvailable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FeatureSupportStatus",
+ "modelAsString": true
+ }
+ },
+ "exposureControlledFeatures": {
+ "description": "support feature type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SyncBackupInstanceRequest": {
+ "description": "Sync BackupInstance Request",
+ "type": "object",
+ "properties": {
+ "syncType": {
+ "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases",
+ "enum": [
+ "Default",
+ "ForceResync"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SyncType",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "TaggingCriteria": {
+ "description": "Tagging criteria",
+ "properties": {
+ "criteria": {
+ "description": "Criteria which decides whether the tag can be applied to a triggered backup.",
+ "items": {
+ "$ref": "#/definitions/BackupCriteria"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "isDefault": {
+ "description": "Specifies if tag is default.",
+ "type": "boolean"
+ },
+ "taggingPriority": {
+ "description": "Retention Tag priority.",
+ "format": "int64",
+ "type": "integer"
+ },
+ "tagInfo": {
+ "$ref": "#/definitions/RetentionTag",
+ "description": "Retention tag information"
+ }
+ },
+ "required": [
+ "isDefault",
+ "tagInfo",
+ "taggingPriority"
+ ],
+ "title": "TaggingCriteria",
+ "type": "object"
+ },
+ "TargetCopySetting": {
+ "description": "Target copy settings",
+ "properties": {
+ "copyAfter": {
+ "$ref": "#/definitions/CopyOption",
+ "description": "It can be CustomCopyOption or ImmediateCopyOption."
+ },
+ "dataStore": {
+ "$ref": "#/definitions/DataStoreInfoBase",
+ "description": "Info of target datastore"
+ }
+ },
+ "required": [
+ "copyAfter",
+ "dataStore"
+ ],
+ "title": "TargetCopySetting",
+ "type": "object"
+ },
+ "TargetDetails": {
+ "description": "Class encapsulating target details, used where the destination is not a datasource",
+ "properties": {
+ "filePrefix": {
+ "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them",
+ "type": "string"
+ },
+ "restoreTargetLocationType": {
+ "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}",
+ "enum": [
+ "Invalid",
+ "AzureBlobs",
+ "AzureFiles"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RestoreTargetLocationType",
+ "modelAsString": true
+ }
+ },
+ "url": {
+ "description": "Url denoting the restore destination. It can point to container / file share etc",
+ "type": "string"
+ },
+ "targetResourceArmId": {
+ "description": "Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share\r\nThis is optional if the target subscription can be identified with the URL field. If not\r\nthen this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states",
+ "type": "string"
+ }
+ },
+ "required": [
+ "filePrefix",
+ "restoreTargetLocationType",
+ "url"
+ ],
+ "type": "object"
+ },
+ "TriggerBackupRequest": {
+ "description": "Trigger backup request",
+ "properties": {
+ "backupRuleOptions": {
+ "$ref": "#/definitions/AdHocBackupRuleOptions",
+ "description": "Name for the Rule of the Policy which needs to be applied for this backup"
+ }
+ },
+ "required": [
+ "backupRuleOptions"
+ ],
+ "title": "TriggerBackupRequest",
+ "type": "object"
+ },
+ "TriggerContext": {
+ "description": "Trigger context",
+ "discriminator": "objectType",
+ "properties": {
+ "objectType": {
+ "description": "Type of the specific object - used for deserializing",
+ "type": "string"
+ }
+ },
+ "required": [
+ "objectType"
+ ],
+ "title": "TriggerContext",
+ "type": "object"
+ },
+ "UserFacingError": {
+ "description": "Error object used by layers that have access to localized content, and propagate that to user",
+ "properties": {
+ "code": {
+ "description": "Unique code for this error",
+ "type": "string"
+ },
+ "details": {
+ "description": "Additional related Errors",
+ "items": {
+ "$ref": "#/definitions/UserFacingError"
+ },
+ "x-ms-identifiers": [],
+ "type": "array"
+ },
+ "innerError": {
+ "$ref": "#/definitions/InnerError",
+ "description": "Inner Error"
+ },
+ "isRetryable": {
+ "description": "Whether the operation will be retryable or not",
+ "type": "boolean"
+ },
+ "isUserError": {
+ "description": "Whether the operation is due to a user error or service error",
+ "type": "boolean"
+ },
+ "properties": {
+ "description": "Any key value pairs that can be injected inside error object",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "message": {
+ "type": "string"
+ },
+ "recommendedAction": {
+ "description": "RecommendedAction � localized.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "target": {
+ "description": "Target of the error.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ValidateForBackupRequest": {
+ "description": "Validate for backup request",
+ "properties": {
+ "backupInstance": {
+ "$ref": "#/definitions/BackupInstance"
+ }
+ },
+ "required": [
+ "backupInstance"
+ ],
+ "title": "ValidateForBackupRequest",
+ "type": "object"
+ },
+ "ValidateRestoreRequestObject": {
+ "description": "Validate restore request object",
+ "properties": {
+ "restoreRequestObject": {
+ "$ref": "#/definitions/AzureBackupRestoreRequest",
+ "description": "Gets or sets the restore request object."
+ }
+ },
+ "required": [
+ "restoreRequestObject"
+ ],
+ "title": "ValidateRestoreRequestObject",
+ "type": "object"
+ },
+ "ResourceGuard": {
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state of the BackupVault resource",
+ "enum": [
+ "Failed",
+ "Provisioning",
+ "Succeeded",
+ "Unknown",
+ "Updating"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "allowAutoApprovals": {
+ "description": "This flag indicates whether auto approval is allowed or not.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "resourceGuardOperations": {
+ "description": "{readonly} List of operation details those are protected by the ResourceGuard resource",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardOperation"
+ },
+ "x-ms-identifiers": [],
+ "readOnly": true
+ },
+ "vaultCriticalOperationExclusionList": {
+ "description": "List of critical operations which are not protected by this resourceGuard",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Description about the pre-req steps to perform all the critical operations.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardOperation": {
+ "description": "This class contains all the details about a critical operation.",
+ "type": "object",
+ "properties": {
+ "vaultCriticalOperation": {
+ "description": "Name of the critical operation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "requestResourceType": {
+ "description": "Type of resource request.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceGuardResource": {
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppBaseTrackedResource"
+ }
+ ],
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ResourceGuard",
+ "description": "ResourceGuardResource properties"
+ }
+ }
+ },
+ "ResourceGuardResourceList": {
+ "description": "List of ResourceGuard resources",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/DppTrackedResourceList"
+ }
+ ],
+ "properties": {
+ "value": {
+ "description": "List of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGuardResource"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "VaultName": {
+ "name": "vaultName",
+ "in": "path",
+ "description": "The name of the backup vault.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "BackupInstanceName": {
+ "name": "backupInstanceName",
+ "in": "path",
+ "description": "The name of the backup instance.",
+ "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."
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ]
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json
new file mode 100644
index 000000000000..ea8de7845b04
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "backupInstanceName": "testInstance1",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "204": {},
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
new file mode 100644
index 000000000000..f9c5594b3506
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "Blob-Backup",
+ "vaultName": "ZBlobBackupVaultBVTD3",
+ "backupInstanceName": "zblobbackuptestsa58",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "sourceDataStoreType": "OperationalStore",
+ "startTime": "2020-10-17T23:28:17.6829685Z",
+ "endTime": "2021-02-24T00:35:17.6829685Z"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "zblobbackuptestsa58",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges",
+ "properties": {
+ "restorableTimeRanges": [
+ {
+ "startTime": "2021-02-23T18:33:51.6349708Z",
+ "endTime": "2021-02-24T00:35:17.0000000Z",
+ "objectType": "RestorableTimeRange"
+ }
+ ],
+ "objectType": "AzureBackupFindRestorableTimeRangesResponse"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstance.json
new file mode 100644
index 000000000000..e22f788104f6
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstance.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
new file mode 100644
index 000000000000..bce778d6700d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "backupInstanceName": "testInstance1",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "ConfiguringProtection"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json
new file mode 100644
index 000000000000..39fbe842499b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListBackupInstances.json
new file mode 100644
index 000000000000..3e1f1ecd764e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListBackupInstances.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2"
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
new file mode 100644
index 000000000000..3cc629e33990
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "expiryTime": "2023-03-01T13:00:00Z",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "0ff03512-b333-4509-a6c7-12164c8b1dce",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25",
+ "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints",
+ "properties": {
+ "objectType": "AzureBackupDiscreteRecoveryPoint",
+ "recoveryPointTime": "2019-03-01T13:00:00Z",
+ "recoveryPointType": "Full",
+ "friendlyName": "panbha4",
+ "recoveryPointDataStoresDetails": [
+ {
+ "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2",
+ "type": "Snapshot",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ },
+ {
+ "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3",
+ "type": "BackupStorage",
+ "creationTime": "2019-03-01T13:00:00Z",
+ "metaData": "123456"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.json
new file mode 100644
index 000000000000..7add8d0c1ee8
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/PutBackupInstance.json
@@ -0,0 +1,167 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "validationType": "ShallowValidation"
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ },
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioning",
+ "objectType": "BackupInstance"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2",
+ "name": "harshitbi2",
+ "type": "Microsoft.DataProtection/backupVaults/backupInstances",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "friendlyName": "harshitbi2",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "testdb",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "OssDB",
+ "resourceName": "viveksipgtest",
+ "resourceType": "OssDB",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1",
+ "policyVersion": "3.2",
+ "policyParameters": {
+ "dataStoreParametersList": [
+ {
+ "objectType": "AzureOperationalStoreParameters",
+ "dataStoreType": "OperationalStore",
+ "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest"
+ }
+ ]
+ }
+ },
+ "protectionStatus": {
+ "status": "NotProtected"
+ },
+ "provisioningState": "Provisioned",
+ "objectType": "BackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeBackups.json
new file mode 100644
index 000000000000..20e4003114e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeProtection.json
new file mode 100644
index 000000000000..20e4003114e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ResumeProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/StopProtection.json
new file mode 100644
index 000000000000..20e4003114e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/StopProtection.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SuspendBackups.json
new file mode 100644
index 000000000000..20e4003114e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SuspendBackups.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json
new file mode 100644
index 000000000000..1ee196a8f2db
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "syncType": "Default"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerBackup.json
new file mode 100644
index 000000000000..06e8cef6c7e7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerBackup.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupRuleOptions": {
+ "ruleName": "BackupWeekly",
+ "triggerOption": {
+ "retentionTagOverride": "yearly"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json
new file mode 100644
index 000000000000..f20646629080
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json
new file mode 100644
index 000000000000..0a3e78e9581b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestore.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
new file mode 100644
index 000000000000..74121624d897
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "targetDetails": {
+ "url": "https://teststorage.blob.core.windows.net/restoretest",
+ "filePrefix": "restoredblob",
+ "restoreTargetLocationType": "AzureBlobs"
+ },
+ "restoreLocation": "southeastasia",
+ "recoveryOption": "FailIfExists",
+ "objectType": "RestoreFilesTargetInfo"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
new file mode 100644
index 000000000000..92a913400abb
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "objectType": "AzureBackupRestoreWithRehydrationRequest",
+ "recoveryPointId": "hardcodedRP",
+ "rehydrationRetentionDuration": "7D",
+ "rehydrationPriority": "High",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateForBackup.json
new file mode 100644
index 000000000000..145e88d682b5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateForBackup.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "backupInstance": {
+ "objectType": "BackupInstance",
+ "friendlyName": "harshitbi2",
+ "dataSourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "dataSourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "OssDB"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
new file mode 100644
index 000000000000..ac027fc6cf17
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1",
+ "parameters": {
+ "restoreRequestObject": {
+ "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
+ "recoveryPointId": "hardcodedRP",
+ "sourceDataStoreType": "VaultStore",
+ "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "restoreTargetInfo": {
+ "objectType": "RestoreTargetInfo",
+ "recoveryOption": "FailIfExists",
+ "datasourceSetInfo": {
+ "objectType": "DatasourceSet",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceInfo": {
+ "objectType": "Datasource",
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
+ "resourceName": "targetdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceUri": "",
+ "resourceLocation": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases"
+ },
+ "datasourceAuthCredentials": {
+ "secretStoreResource": {
+ "uri": "https://samplevault.vault.azure.net/secrets/credentials",
+ "secretStoreType": "AzureKeyVault"
+ },
+ "objectType": "SecretStoreBasedAuthCredentials"
+ },
+ "restoreLocation": "southeastasia"
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/CheckfeatureSupport.json
new file mode 100644
index 000000000000..a8c45864ff08
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/CheckfeatureSupport.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "featureType": "DataSourceType",
+ "objectType": "FeatureValidationRequest"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "featureType": "DataSourceType",
+ "features": [
+ {
+ "featureName": "Microsoft.Storage/storageAccounts/blobServices",
+ "supportStatus": "PrivatePreview",
+ "exposureControlledFeatures": []
+ },
+ {
+ "featureName": "Microsoft.DBforPostgreSQL/servers/databases",
+ "supportStatus": "PublicPreview",
+ "exposureControlledFeatures": []
+ }
+ ],
+ "objectType": "FeatureValidationResponse"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
new file mode 100644
index 000000000000..ee0a93d146dd
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01",
+ "backupInstanceName": "testInstance1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
new file mode 100644
index 000000000000..2290151a95bc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PratikPrivatePreviewVault1",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1",
+ "name": "testInstance1",
+ "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances",
+ "properties": {
+ "friendlyName": "testInstance1",
+ "dataSourceInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "testdb",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceLocation": "",
+ "objectType": "Datasource"
+ },
+ "dataSourceSetInfo": {
+ "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
+ "resourceUri": "",
+ "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "resourceName": "viveksipgtest",
+ "resourceType": "Microsoft.DBforPostgreSQL/servers",
+ "resourceLocation": "",
+ "objectType": "DatasourceSet"
+ },
+ "deletionInfo": {
+ "deletionTime": "2022-05-04T00:00:36.6660445Z",
+ "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z",
+ "billingEndDate": "2022-05-06T00:00:36.6660445Z",
+ "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4"
+ },
+ "policyInfo": {
+ "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
+ },
+ "protectionStatus": {
+ "status": "SoftDeleted"
+ },
+ "provisioningState": "Succeeded",
+ "objectType": "DeletedBackupInstance"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
new file mode 100644
index 000000000000..20e4003114e2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "testrg",
+ "vaultName": "testvault",
+ "backupInstanceName": "testbi",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationResult.json
new file mode 100644
index 000000000000..459ca8b5b249
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationResult.json
@@ -0,0 +1,23 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01",
+ "Retry-After": "60"
+ }
+ },
+ "200": {
+ "body": {
+ "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "objectType": "OperationJobExtendedInfo"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatus.json
new file mode 100644
index 000000000000..67be08d0dd19
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatus.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "location": "WestUS",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusRGContext.json
new file mode 100644
index 000000000000..11c8c9421031
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusRGContext.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusVaultContext.json
new file mode 100644
index 000000000000..6d6350abb406
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/GetOperationStatusVaultContext.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==",
+ "status": "Succeeded",
+ "startTime": "2019-11-20T09:49:44.0478496Z",
+ "endTime": "2019-11-20T09:49:46Z"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetExportJobsOperationResult.json
new file mode 100644
index 000000000000..f8c7bb752e1c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetExportJobsOperationResult.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "operationId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000",
+ "blobSasKey": "someKey",
+ "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx",
+ "excelFileBlobSasKey": "someKey"
+ }
+ },
+ "202": {
+ "headers": {
+ "Retry-After": 60,
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-01-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
new file mode 100644
index 000000000000..bab56fc2e9a4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/GetJob.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap",
+ "extendedInfo": {
+ "subTasks": [
+ {
+ "taskId": 1,
+ "taskName": "Trigger Backup",
+ "taskStatus": "Started"
+ }
+ ],
+ "additionalDetails": {
+ "RetentionTag": "Default",
+ "PolicyRuleName": "BackupWeekly",
+ "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9"
+ }
+ }
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/ListJobs.json
new file mode 100644
index 000000000000..c951de849c24
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/ListJobs.json
@@ -0,0 +1,135 @@
+{
+ "parameters": {
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "resourceGroupName": "BugBash1",
+ "vaultName": "BugBashVaultForCCYv11",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "properties": {
+ "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4",
+ "policyName": "jakavetPolicy2",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb4",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T05:00:08.1746833Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002",
+ "name": "8989416e-7573-4836-8cf1-0e90954f1002",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5",
+ "policyName": "jakavetPolicy3",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb5",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-16T18:00:03.6660733Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2",
+ "policyName": "jakavetdailypolicy",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb2",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T03:00:03.7604146Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Started",
+ "isUserTriggered": false,
+ "supportedActions": [],
+ "duration": "00:00:00",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ },
+ {
+ "properties": {
+ "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz",
+ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e",
+ "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1",
+ "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3",
+ "vaultName": "BugBashVaultForCCYv11",
+ "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3",
+ "policyName": "jakavetPolicy1",
+ "sourceResourceGroup": "DppPostgresTestingCcy",
+ "dataSourceSetName": "mabtestingccybasicv11",
+ "dataSourceName": "bugbashdb3",
+ "progressEnabled": false,
+ "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965",
+ "startTime": "2021-03-17T11:11:50.5595259Z",
+ "endTime": "2021-03-17T11:14:02.5319646Z",
+ "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases",
+ "operationCategory": "Backup",
+ "operation": "Backup",
+ "status": "Succeeded",
+ "isUserTriggered": true,
+ "supportedActions": [
+ ""
+ ],
+ "duration": "00:02:11.9724387",
+ "dataSourceLocation": "centraluseuap"
+ },
+ "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097",
+ "name": "43252662-1b43-44fd-a856-0055665cb097",
+ "type": "Microsoft.DataProtection/Backupvaults/backupJobs"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/TriggerExportJobs.json
new file mode 100644
index 000000000000..a10ddbca4efc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/JobCRUD/TriggerExportJobs.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "SwaggerTestRg",
+ "vaultName": "NetSDKTestRsVault",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-01-01",
+ "Retry-After": 60
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/Operations/List.json
new file mode 100644
index 000000000000..c597978823a9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/Operations/List.json
@@ -0,0 +1,533 @@
+{
+ "parameters": {
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DataProtection/locations/getBackupStatus/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Status",
+ "operation": "Check Backup Status for Vault",
+ "description": "Check Backup Status for Recovery Services Vaults"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Create a Backup Instance",
+ "description": "Creates a Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Delete Backup Instance",
+ "description": "Deletes the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instance Details",
+ "description": "Returns details of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Instances",
+ "description": "Returns all Backup Instances"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Backup Backup Instance",
+ "description": "Performs Backup on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Sync Backup Instance",
+ "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Stop Protection of Backup Instance",
+ "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Suspend Backups of Backup Instance",
+ "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Protection of Backup Instance",
+ "description": "Resume protection of a ProtectionStopped BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Resume Backups of Backup Instance",
+ "description": "Resume Backups for a BackupsSuspended BI."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Validate for Restore of Backup Instance",
+ "description": "Validates for Restore of the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Instance",
+ "operation": "Restore Backup Instance",
+ "description": "Triggers restore on the Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Create Backup Policy",
+ "description": "Creates Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Delete Backup Policy",
+ "description": "Deletes the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policy details",
+ "description": "Returns details of the Backup Policy"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Policies",
+ "operation": "Get Backup Policies",
+ "description": "Returns all Backup Policies"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get the list of ResourceGuard proxies for a resource",
+ "description": "Get the list of ResourceGuard proxies for a resource"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Get ResourceGuard proxy",
+ "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Create ResourceGuard proxy",
+ "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Delete ResourceGuard proxy",
+ "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guard Proxy",
+ "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation",
+ "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Point Details",
+ "description": "Returns details of the Recovery Point"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Recovery Points",
+ "operation": "Get Recovery Points",
+ "description": "Returns all Recovery Points"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Restorable Time Ranges",
+ "operation": "Find Restorable Time Ranges",
+ "description": "Finds Restorable Time Ranges"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Create Backup Vault",
+ "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Operation Result of a Patch Operation for a Backup Vault",
+ "description": "Gets Operation Result of a Patch Operation for a Backup Vault"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/checkNameAvailability/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Check if the requested BackupVault Name is Available",
+ "description": "Checks if the requested BackupVault Name is Available"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Resource Group",
+ "description": "Gets list of Backup Vaults in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Vaults",
+ "operation": "Get Backup Vaults in a Subscription",
+ "description": "Gets list of Backup Vaults in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Create ResourceGuard",
+ "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard",
+ "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Delete ResourceGuard",
+ "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Resource Group",
+ "description": "Gets list of ResourceGuards in a Resource Group"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuards in a Subscription",
+ "description": "Gets list of ResourceGuards in a Subscription"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Update ResourceGuard",
+ "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard operation request info",
+ "description": "Gets ResourceGuard operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Guards",
+ "operation": "Get ResourceGuard default operation request info",
+ "description": "Gets ResourceGuard default operation request info"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Validate if a feature is supported",
+ "description": "Validates if a feature is supported"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Status",
+ "operation": "Get Backup Operation Status",
+ "description": "Returns Backup Operation Status for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/locations/operationResults/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Operation Results",
+ "operation": "Get Backup Operation Result",
+ "description": "Returns Backup Operation Result for Backup Vault."
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Validate Backup",
+ "operation": "Validate for backup of Backup Instance",
+ "description": "Validates for backup of Backup Instance"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/backupVaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Jobs",
+ "description": "Get Jobs list"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Backup Jobs",
+ "operation": "Backup Job Object",
+ "description": "Get Job details"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/register/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Register Resource Provider",
+ "description": "Registers subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/unregister/action",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "Unregister Resource Provider",
+ "description": "Unregisters subscription for given Resource Provider"
+ },
+ "origin": "user"
+ },
+ {
+ "name": "Microsoft.DataProtection/operations/read",
+ "display": {
+ "provider": "Microsoft.DataProtection",
+ "resource": "Resource Provider Operation",
+ "operation": "List of Operations",
+ "description": "Operation returns the list of Operations for a Resource Provider"
+ },
+ "origin": "user"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
new file mode 100644
index 000000000000..920b0d829674
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json
@@ -0,0 +1,200 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json
new file mode 100644
index 000000000000..784cde86ca0b
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/GetBackupPolicy.json
new file mode 100644
index 000000000000..7b6c214da5b4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/GetBackupPolicy.json
@@ -0,0 +1,109 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "backupPolicyName": "OSSDBPolicy",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/ListBackupPolicy.json
new file mode 100644
index 000000000000..7f9c5ca1851a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/PolicyCRUD/ListBackupPolicy.json
@@ -0,0 +1,112 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "000pikumar",
+ "vaultName": "PrivatePreviewVault",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy",
+ "name": "OSSDBPolicy",
+ "type": "Microsoft.DataProtection/backupVaults/backupPolicies",
+ "properties": {
+ "policyRules": [
+ {
+ "backupParameters": {
+ "backupType": "Full",
+ "objectType": "AzureBackupParams"
+ },
+ "trigger": {
+ "schedule": {
+ "repeatingTimeIntervals": [
+ "R/2019-11-20T08:00:00-08:00/P1W"
+ ]
+ },
+ "taggingCriteria": [
+ {
+ "tagInfo": {
+ "tagName": "Default",
+ "id": "Default_"
+ },
+ "taggingPriority": 99,
+ "isDefault": true
+ },
+ {
+ "tagInfo": {
+ "tagName": "Weekly",
+ "id": "Weekly_"
+ },
+ "taggingPriority": 20,
+ "isDefault": false,
+ "criteria": [
+ {
+ "scheduleTimes": [
+ "2019-03-01T13:00:00Z"
+ ],
+ "daysOfTheWeek": [
+ "Sunday"
+ ],
+ "objectType": "ScheduleBasedBackupCriteria"
+ }
+ ]
+ }
+ ],
+ "objectType": "ScheduleBasedTriggerContext"
+ },
+ "dataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "name": "BackupWeekly",
+ "objectType": "AzureBackupRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P1W"
+ }
+ }
+ ],
+ "isDefault": true,
+ "name": "Default",
+ "objectType": "AzureRetentionRule"
+ },
+ {
+ "lifecycles": [
+ {
+ "sourceDataStore": {
+ "dataStoreType": "VaultStore",
+ "objectType": "DataStoreInfoBase"
+ },
+ "deleteAfter": {
+ "objectType": "AbsoluteDeleteOption",
+ "duration": "P12W"
+ }
+ }
+ ],
+ "isDefault": false,
+ "name": "Weekly",
+ "objectType": "AzureRetentionRule"
+ }
+ ],
+ "datasourceTypes": [
+ "OssDB"
+ ],
+ "objectType": "BackupPolicy"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json
new file mode 100644
index 000000000000..0063d2dffb34
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..e8160ed2fbd7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..4b8d1ee0ee8c
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..7df4a57d4a66
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..63122d4b1da4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..948a26c8262a
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..bc0e8db05fd0
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "requestName": "default",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json
new file mode 100644
index 000000000000..0a30a34ad6cc
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "ResourceGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
new file mode 100644
index 000000000000..5dc61199b9a0
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
new file mode 100644
index 000000000000..9fb581538a26
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
new file mode 100644
index 000000000000..dec68894e28d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
new file mode 100644
index 000000000000..85b5d91a6c40
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
new file mode 100644
index 000000000000..684ead146235
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
new file mode 100644
index 000000000000..e9d423216d78
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
new file mode 100644
index 000000000000..60f68de501f9
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
new file mode 100644
index 000000000000..88cd22c3c6b8
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json
@@ -0,0 +1,21 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default",
+ "name": "default",
+ "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
new file mode 100644
index 000000000000..a12dc1f3d6a5
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json
new file mode 100644
index 000000000000..3d54c359d745
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "resourceGuardsName": "swaggerExample",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "location": "eastus",
+ "tags": {
+ "TestKey": "TestValue"
+ },
+ "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew",
+ "name": "VaultGuardTestNew",
+ "type": "Microsoft.DataProtection/resourceGuards",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "allowAutoApprovals": true,
+ "resourceGuardOperations": [
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests"
+ },
+ {
+ "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write",
+ "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests"
+ }
+ ],
+ "description": "Please take JIT access before performing any of the critical operation",
+ "vaultCriticalOperationExclusionList": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
new file mode 100644
index 000000000000..060f0a8d8f43
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "location": "westus",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "name": "swaggerExample"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/DeleteBackupVault.json
new file mode 100644
index 000000000000..1ddb1b058f8e
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/DeleteBackupVault.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {},
+ "204": {},
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVault.json
new file mode 100644
index 000000000000..b9e5b419d4b2
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVault.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json
new file mode 100644
index 000000000000..aad401af01ef
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
new file mode 100644
index 000000000000..d1c2274329aa
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json
@@ -0,0 +1,64 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json
new file mode 100644
index 000000000000..d1ba273d85b4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json
@@ -0,0 +1,56 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1",
+ "name": "ExampleVault1",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2",
+ "name": "ExampleVault2",
+ "type": "Microsoft.DataProtection/BackupVaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetOperationResultPatch.json
new file mode 100644
index 000000000000..5ac48035f925
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/GetOperationResultPatch.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "api-version": "2023-01-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ },
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Retry-After": "60"
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PatchBackupVault.json
new file mode 100644
index 000000000000..7fde8270bae4
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PatchBackupVault.json
@@ -0,0 +1,55 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01",
+ "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==",
+ "parameters": {
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01",
+ "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "newKey": "newVal"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVault.json
new file mode 100644
index 000000000000..bc34eaca45a7
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVault.json
@@ -0,0 +1,89 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "None"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "type": "None"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json
new file mode 100644
index 000000000000..2b3b637b464d
--- /dev/null
+++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json
@@ -0,0 +1,91 @@
+{
+ "parameters": {
+ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c",
+ "resourceGroupName": "SampleResourceGroup",
+ "vaultName": "swaggerExample",
+ "api-version": "2023-01-01",
+ "parameters": {
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "identity": {
+ "type": "systemAssigned"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Provisioning",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ },
+ "headers": {
+ "Retry-After": "10",
+ "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-01-01"
+ }
+ },
+ "200": {
+ "body": {
+ "identity": {
+ "principalId": "c009b9a0-0024-417c-83cd-025d3776045d",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "type": "SystemAssigned"
+ },
+ "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample",
+ "name": "swaggerExample",
+ "type": "Microsoft.DataProtection/Backupvaults",
+ "location": "WestUS",
+ "tags": {
+ "key1": "val1"
+ },
+ "properties": {
+ "monitoringSettings": {
+ "azureMonitorAlertSettings": {
+ "alertsForAllJobFailures": "Enabled"
+ }
+ },
+ "provisioningState": "Succeeded",
+ "storageSettings": [
+ {
+ "datastoreType": "VaultStore",
+ "type": "LocallyRedundant"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/dataprotection/resource-manager/readme.go.md b/specification/dataprotection/resource-manager/readme.go.md
index b0a905f38386..b6bbd90dd8d0 100644
--- a/specification/dataprotection/resource-manager/readme.go.md
+++ b/specification/dataprotection/resource-manager/readme.go.md
@@ -28,6 +28,16 @@ batch:
- tag: package-2021-01
- tag: package-2021-07
- tag: package-2022-03
+ - tag: package-2023-01
+```
+
+### Tag: package-2023-01 and go
+
+These settings apply only when `--tag=package-2023-01 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag)=='package-2023-01' && $(go)
+output-folder: $(go-sdk-folder)/services/dataprotection/mgmt/2023-01-01/$(namespace)
```
### Tag: package-2022-03 and go
diff --git a/specification/dataprotection/resource-manager/readme.java.md b/specification/dataprotection/resource-manager/readme.java.md
index c4cdc9469b73..1a3ca3e93e29 100644
--- a/specification/dataprotection/resource-manager/readme.java.md
+++ b/specification/dataprotection/resource-manager/readme.java.md
@@ -24,6 +24,20 @@ batch:
- tag: package-2021-01
- tag: package-2021-07
- tag: package-2022-03
+ - tag: package-2023-01
+```
+
+### Tag: package-2023-01 and java
+
+These settings apply only when `--tag=package-2023-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2023-01' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.dataprotection.v2023_01_01
+ output-folder: $(azure-libraries-for-java-folder)/dataprotection/resource-manager/v2023_01_01
+regenerate-manager: true
+generate-interface: true
```
### Tag: package-2022-03 and java
diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md
index 60886dacf453..536b4eb1e36e 100644
--- a/specification/dataprotection/resource-manager/readme.md
+++ b/specification/dataprotection/resource-manager/readme.md
@@ -28,7 +28,7 @@ These are the global settings for the DataProtection API.
title: Data Protection Client
description: Open API 2.0 Specs for Azure Data Protection service
openapi-type: arm
-tag: package-2022-10-preview
+tag: package-2023-01
csharp-sdks-folder: ./Generated/CSharp
python-sdks-folder: ./Generated/Python
go-sdk-folder: ./Generated/Golang
@@ -46,6 +46,33 @@ semantic-validator: true
message-format: json
```
+### Tag: package-2023-01
+
+These settings apply only when `--tag=package-2023-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2023-01'
+input-file:
+- Microsoft.DataProtection/stable/2023-01-01/dataprotection.json
+```
+
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-12'
+input-file:
+- Microsoft.DataProtection/stable/2022-12-01/dataprotection.json
+```
+
+### Tag: package-preview-2022-11
+
+These settings apply only when `--tag=package-preview-2022-11` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2022-11'
+input-file:
+ - Microsoft.DataProtection/preview/2022-11-01-preview/dataprotection.json
+```
+
### Tag: package-2022-10-preview
These settings apply only when `--tag=package-2022-10-preview` is specified on the command line.
@@ -59,10 +86,11 @@ input-file:
These settings apply only when `--tag=package-preview-2022-09` is specified on the command line.
-```yaml $(tag) == 'package-preview-2022-09'
+``` yaml $(tag) == 'package-preview-2022-09'
input-file:
- Microsoft.DataProtection/preview/2022-09-01-preview/dataprotection.json
```
+
### Tag: package-2022-05
These settings apply only when `--tag=package-2022-05` is specified on the command line.
diff --git a/specification/dataprotection/resource-manager/readme.ruby.md b/specification/dataprotection/resource-manager/readme.ruby.md
index 7071b1c55f20..5119559d59a3 100644
--- a/specification/dataprotection/resource-manager/readme.ruby.md
+++ b/specification/dataprotection/resource-manager/readme.ruby.md
@@ -17,6 +17,17 @@ batch:
- tag: package-2021-06-preview
- tag: package-2021-02-preview
- tag: package-2022-03
+ - tag: package-2023-01
+```
+
+### Tag: package-2023-01 and ruby
+
+These settings apply only when `--tag= package-2023-01 --ruby` is specified on the command line.
+Please also specify `--ruby-sdks-folder=`.
+
+``` yaml $(tag) == ' package-2023-01' && $(ruby)
+namespace: "Azure::DataProtection::Mgmt::V2023_01_01"
+output-folder: $(ruby-sdks-folder)/management/azure_mgmt_data_protection/lib
```
### Tag: package-2022-03 and ruby
diff --git a/specification/dataprotection/resource-manager/readme.typescript.md b/specification/dataprotection/resource-manager/readme.typescript.md
index 30b57fb89bdd..96c176278d7c 100644
--- a/specification/dataprotection/resource-manager/readme.typescript.md
+++ b/specification/dataprotection/resource-manager/readme.typescript.md
@@ -6,7 +6,7 @@ Please also specify `--typescript-sdks-folder=`.
-``` yaml $(java)
-azure-arm: true
-fluent: true
-namespace: com.microsoft.azure.management.desktopvirtualization
-license-header: MICROSOFT_MIT_NO_CODEGEN
-payload-flattening-threshold: 1
-output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-desktopvirtualization
+```yaml $(java)
+generate-async-methods: true
```
-
-### Java multi-api
-
-``` yaml $(java) && $(multiapi)
-batch:
- - tag: package-2020-10-19-preview
- - tag: package-2020-11-02-preview
- - tag: package-2020-11-10-preview
- - tag: package-2021-01-14-preview
- - tag: package-2021-02-01-preview
- - tag: package-2021-03-09-preview
- - tag: package-2021-04-01-preview
-```
-
-### Tag: package-2021-04-01-preview and java
-
-These settings apply only when `--tag=package-2021-04-01-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2021-04-01-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2021_04-01-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2021_04-01-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2021-03-09-preview and java
-
-These settings apply only when `--tag=package-2021-03-09-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2021-03-09-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2021_03-09-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2021_03-09-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2021-02-01-preview and java
-
-These settings apply only when `--tag=package-2021-02-01-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2021-02-01-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2021_02-01-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2021_02-01-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2021-01-14-preview and java
-
-These settings apply only when `--tag=package-2021-01-14-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2021-01-14-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2021_01-14-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2021_01-14-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2020-11-10-preview and java
-
-These settings apply only when `--tag=package-2020-11-10-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2020-11-10-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2020_11-10-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2020_11-10-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2020-11-02-preview and java
-
-These settings apply only when `--tag=package-2020-11-02-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2020-11-02-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2020_11-02-preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2020_11-02-preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2020-10-19-preview and java
-
-These settings apply only when `--tag=package-2020-10-19-preview --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=`.
-
-``` yaml $(tag) == 'package-2020-10-19-preview' && $(java) && $(multiapi)
-java:
- namespace: com.microsoft.azure.management.desktopvirtualization.v2020_10_19_preview
- output-folder: $(azure-libraries-for-java-folder)/sdk/desktopvirtualization/mgmt-v2020_10_19_preview
-regenerate-manager: true
-generate-interface: true
-```
-
diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md
index 4fb387f39de6..7f750e606e9d 100644
--- a/specification/desktopvirtualization/resource-manager/readme.md
+++ b/specification/desktopvirtualization/resource-manager/readme.md
@@ -26,18 +26,27 @@ These are the global settings for the DesktopVirtualizationClient API.
``` yaml
openapi-type: arm
-tag: package-2022-09
+tag: package-preview-2022-10
```
+### Tag: package-preview-2022-10
+
+These settings apply only when `--tag=package-preview-2022-10` is specified on the command line.
+
+```yaml $(tag) == 'package-preview-2022-10'
+input-file:
+ - Microsoft.DesktopVirtualization/preview/2022-10-14-preview/desktopvirtualization.json
+```
### Tag: package-2022-09
These settings apply only when `--tag=package-2022-09` is specified on the command line.
-```yaml $(tag) == 'package-2022-09'
+``` yaml $(tag) == 'package-2022-09'
input-file:
- Microsoft.DesktopVirtualization/stable/2022-09-09/desktopvirtualization.json
```
+
### Tag: package-preview-2022-04
These settings apply only when `--tag=package-preview-2022-04` is specified on the command line.
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCertificateCreateOrUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCertificateCreateOrUpdate.json
new file mode 100644
index 000000000000..a3252354f829
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCertificateCreateOrUpdate.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSCheckNameAvailability.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCheckNameAvailability.json
new file mode 100644
index 000000000000..3fdc0e2498ca
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCheckNameAvailability.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSCreate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCreate.json
new file mode 100644
index 000000000000..52e489a950d5
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCreate.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSCreateOrUpdatePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCreateOrUpdatePrivateEndpointConnection.json
new file mode 100644
index 000000000000..88a47af92232
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSCreateOrUpdatePrivateEndpointConnection.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSDelete.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDelete.json
new file mode 100644
index 000000000000..9ab5bbf2ddc5
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDelete.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSDeleteCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDeleteCertificate.json
new file mode 100644
index 000000000000..cb5a21e42517
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDeleteCertificate.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0",
+ "certificateName": "cert",
+ "If-Match": "AAAAAAAADGk="
+ },
+ "responses": {
+ "200": {},
+ "204": {}
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDeletePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDeletePrivateEndpointConnection.json
new file mode 100644
index 000000000000..0da9475c519e
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSDeletePrivateEndpointConnection.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGenerateVerificationCode.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGenerateVerificationCode.json
new file mode 100644
index 000000000000..8bbd4d153ddf
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGenerateVerificationCode.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGet.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGet.json
new file mode 100644
index 000000000000..c7682dea8459
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGet.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetCertificate.json
new file mode 100644
index 000000000000..412d49f4dfb8
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetCertificate.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGetCertificates.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetCertificates.json
new file mode 100644
index 000000000000..91bf2c1faec9
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetCertificates.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGetKey.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetKey.json
new file mode 100644
index 000000000000..04496f167909
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetKey.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGetOperationResult.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetOperationResult.json
new file mode 100644
index 000000000000..61a13afa8237
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetOperationResult.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0",
+ "operationId": "MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl",
+ "asyncinfo": "1508265712453"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded"
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetPrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetPrivateEndpointConnection.json
new file mode 100644
index 000000000000..7b838676146a
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetPrivateEndpointConnection.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGetPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetPrivateLinkResources.json
new file mode 100644
index 000000000000..02d75a2238db
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetPrivateLinkResources.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSGetValidSku.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetValidSku.json
new file mode 100644
index 000000000000..46211f36c2e3
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSGetValidSku.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "S1"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListByResourceGroup.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListByResourceGroup.json
new file mode 100644
index 000000000000..9e030682bcc1
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListByResourceGroup.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2022-12-12",
+ "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
+ }
+ },
+ {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListBySubscription.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListBySubscription.json
new file mode 100644
index 000000000000..1a4353d91fef
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListBySubscription.json
@@ -0,0 +1,60 @@
+{
+ "parameters": {
+ "api-version": "2022-12-12",
+ "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
+ }
+ },
+ {
+ "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
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListKeys.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListKeys.json
new file mode 100644
index 000000000000..ec47de9cc8a4
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListKeys.json
@@ -0,0 +1,28 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSListPrivateEndpointConnections.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListPrivateEndpointConnections.json
new file mode 100644
index 000000000000..0adc6b63640a
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListPrivateEndpointConnections.json
@@ -0,0 +1,29 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSListPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListPrivateLinkResources.json
new file mode 100644
index 000000000000..bb950ba7cb50
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSListPrivateLinkResources.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "resourceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/examples/DPSOperations.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSOperations.json
new file mode 100644
index 000000000000..50d7ca46d962
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSOperations.json
@@ -0,0 +1,293 @@
+{
+ "parameters": {
+ "api-version": "2022-12-12"
+ },
+ "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/stable/2022-12-12/examples/DPSPatch.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSPatch.json
new file mode 100644
index 000000000000..8a2c273d1dd6
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSPatch.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSVerifyCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSVerifyCertificate.json
new file mode 100644
index 000000000000..73170634a9b0
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/examples/DPSVerifyCertificate.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "provisioningServiceName": "myFirstProvisioningService",
+ "resourceGroupName": "myResourceGroup",
+ "api-version": "2022-12-12",
+ "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/stable/2022-12-12/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json
new file mode 100644
index 000000000000..d1ec8c81ddab
--- /dev/null
+++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2022-12-12/iotdps.json
@@ -0,0 +1,2571 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-12",
+ "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"
+ }
+ },
+ "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
+ }
+ },
+ "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."
+ }
+ },
+ "required": [
+ "connectionString",
+ "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 43704e7bf8b1..4ad14eb0cf12 100644
--- a/specification/deviceprovisioningservices/resource-manager/readme.md
+++ b/specification/deviceprovisioningservices/resource-manager/readme.md
@@ -26,19 +26,28 @@ These are the global settings for the API.
``` yaml
openapi-type: arm
-azure-arm: true
-tag: package-2022-02
+azure-arm: true
+tag: package-2022-12
```
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.Devices/stable/2022-12-12/iotdps.json
+```
### Tag: package-2022-02
These settings apply only when `--tag=package-2022-02` is specified on the command line.
-```yaml $(tag) == 'package-2022-02'
+``` yaml $(tag) == 'package-2022-02'
input-file:
- Microsoft.Devices/stable/2022-02-05/iotdps.json
```
+
### Tag: package-preview-2020-09
These settings apply only when `--tag=package-preview-2020-09` is specified on the command line.
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/deviceupdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/deviceupdate.json
new file mode 100644
index 000000000000..be2bc77bd8f8
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/deviceupdate.json
@@ -0,0 +1,1997 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "DeviceUpdate",
+ "description": "Microsoft Device Update resource provider.",
+ "version": "2022-12-01-preview"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
+ }
+ ],
+ "securityDefinitions": {
+ "azure_auth": {
+ "type": "oauth2",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+ "flow": "implicit",
+ "description": "Azure Active Directory OAuth2 flow.",
+ "scopes": {
+ "user_impersonation": "Impersonate your user account"
+ }
+ }
+ },
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DeviceUpdate/checknameavailability": {
+ "post": {
+ "description": "Checks ADU resource name availability.",
+ "operationId": "CheckNameAvailability",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest"
+ },
+ "in": "body",
+ "name": "request",
+ "required": true,
+ "description": "Check Name Availability Request."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Check Name Availability Response.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CheckNameAvailability_Available": {
+ "$ref": "./examples/CheckNameAvailability_Available.json"
+ },
+ "CheckNameAvailability_AlreadyExists": {
+ "$ref": "./examples/CheckNameAvailability_AlreadyExists.json"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DeviceUpdate/accounts": {
+ "get": {
+ "description": "Returns list of Accounts.",
+ "operationId": "Accounts_ListBySubscription",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of Accounts.",
+ "schema": {
+ "$ref": "#/definitions/AccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get list of Accounts": {
+ "$ref": "./examples/Accounts/Accounts_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts": {
+ "get": {
+ "description": "Returns list of Accounts.",
+ "operationId": "Accounts_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of Accounts.",
+ "schema": {
+ "$ref": "#/definitions/AccountList"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Gets list of Accounts": {
+ "$ref": "./examples/Accounts/Accounts_List.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}": {
+ "get": {
+ "description": "Returns account details for the given account name.",
+ "operationId": "Accounts_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Account details.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets Account details": {
+ "$ref": "./examples/Accounts/Accounts_Get.json"
+ }
+ }
+ },
+ "head": {
+ "description": "Checks whether account exists.",
+ "operationId": "Accounts_Head",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Account exists."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Checks whether account exists": {
+ "$ref": "./examples/Accounts/Accounts_Head.json"
+ }
+ }
+ },
+ "put": {
+ "description": "Creates or updates Account.",
+ "operationId": "Accounts_Create",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "Account",
+ "description": "Account details.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Async operation to create or update Account was created.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates or updates Account": {
+ "$ref": "./examples/Accounts/Accounts_Create.json"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes account.",
+ "operationId": "Accounts_Delete",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Account was deleted."
+ },
+ "202": {
+ "description": "Async operation to delete Account was created.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Operation Status Location URI"
+ }
+ }
+ },
+ "204": {
+ "description": "Account has been already deleted."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Deletes an account": {
+ "$ref": "./examples/Accounts/Accounts_Delete.json"
+ }
+ }
+ },
+ "patch": {
+ "description": "Updates account's patchable properties",
+ "operationId": "Accounts_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "name": "accountUpdatePayload",
+ "description": "Updated Account.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AccountUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Account updated successfully.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "201": {
+ "description": "Async operation to update accounts was created.",
+ "schema": {
+ "$ref": "#/definitions/Account"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "x-ms-examples": {
+ "Updates Account": {
+ "$ref": "./examples/Accounts/Accounts_Update.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances": {
+ "get": {
+ "description": "Returns instances for the given account name.",
+ "operationId": "Instances_ListByAccount",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "List of Instances.",
+ "schema": {
+ "$ref": "#/definitions/InstanceList"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Gets list of Instances by Account": {
+ "$ref": "./examples/Instances/Instances_ListByAccount.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/instances/{instanceName}": {
+ "get": {
+ "description": "Returns instance details for the given instance and account name.",
+ "operationId": "Instances_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/InstanceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Instance details.",
+ "schema": {
+ "$ref": "#/definitions/Instance"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets list of Instances": {
+ "$ref": "./examples/Instances/Instances_Get.json"
+ }
+ }
+ },
+ "head": {
+ "description": "Checks whether instance exists.",
+ "operationId": "Instances_Head",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/InstanceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Instance exists."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Checks whether instance exists.": {
+ "$ref": "./examples/Instances/Instances_Head.json"
+ }
+ }
+ },
+ "put": {
+ "description": "Creates or updates instance.",
+ "operationId": "Instances_Create",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/InstanceNameParameter"
+ },
+ {
+ "name": "Instance",
+ "description": "Instance details.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Instance"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Async operation to create or update Instance was created.",
+ "schema": {
+ "$ref": "#/definitions/Instance"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates or updates Instance": {
+ "$ref": "./examples/Instances/Instances_Create.json"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes instance.",
+ "operationId": "Instances_Delete",
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/InstanceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Instance was deleted."
+ },
+ "202": {
+ "description": "Async operation to delete Instance was created.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Operation Status Location URI"
+ }
+ }
+ },
+ "204": {
+ "description": "Instance has been already deleted."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Deletes instance": {
+ "$ref": "./examples/Instances/Instances_Delete.json"
+ }
+ }
+ },
+ "patch": {
+ "description": "Updates instance's tags.",
+ "operationId": "Instances_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/InstanceNameParameter"
+ },
+ {
+ "name": "tagUpdatePayload",
+ "description": "Updated tags.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Instance updated successfully.",
+ "schema": {
+ "$ref": "#/definitions/Instance"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Updates Instance": {
+ "$ref": "./examples/Instances/Instances_Update.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "List all private endpoint connections in a device update account.",
+ "operationId": "PrivateEndpointConnections_ListByAccount",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionList": {
+ "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Get the specified private endpoint connection associated with the device update account.",
+ "operationId": "PrivateEndpointConnections_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionGet": {
+ "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Update the state of specified private endpoint connection associated with the device update account.",
+ "operationId": "PrivateEndpointConnections_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ },
+ {
+ "name": "privateEndpointConnection",
+ "in": "body",
+ "description": "The parameters for creating a private endpoint connection.",
+ "required": true,
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionCreateOrUpdate": {
+ "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "Deletes the specified private endpoint connection associated with the device update account.",
+ "operationId": "PrivateEndpointConnections_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "./privatelinks.json#/parameters/PrivateEndpointConnectionName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation completed synchronously."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Operation Status Location URI"
+ }
+ }
+ },
+ "204": {
+ "description": "The private endpoint connection does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionDelete": {
+ "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "description": "List all private link resources in a device update account.",
+ "operationId": "PrivateLinkResources_ListByAccount",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResourcesList": {
+ "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateLinkResources/{groupId}": {
+ "get": {
+ "tags": [
+ "PrivateLinkResources"
+ ],
+ "description": "Get the specified private link resource associated with the device update account.",
+ "operationId": "PrivateLinkResources_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/GroupInformation"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateLinkResourcesGet": {
+ "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_Get.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnectionProxies"
+ ],
+ "description": "(INTERNAL - DO NOT USE) List all private endpoint connection proxies in a device update account.",
+ "operationId": "PrivateEndpointConnectionProxies_ListByAccount",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxyListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyList": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_ListByAccount.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}/validate": {
+ "post": {
+ "description": "(INTERNAL - DO NOT USE) Validates a private endpoint connection proxy object.",
+ "operationId": "PrivateEndpointConnectionProxies_Validate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionProxyIdParameter"
+ },
+ {
+ "name": "privateEndpointConnectionProxy",
+ "in": "body",
+ "description": "The parameters for creating a private endpoint connection proxy.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxy"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Validate private endpoint connection proxy empty response."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyValidate": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Validate.json"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}/updatePrivateEndpointProperties": {
+ "post": {
+ "description": "(INTERNAL - DO NOT USE) Updates a private endpoint inside the private endpoint connection proxy object.",
+ "operationId": "PrivateEndpointConnectionProxies_UpdatePrivateEndpointProperties",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionProxyIdParameter"
+ },
+ {
+ "name": "privateEndpointUpdate",
+ "in": "body",
+ "description": "The parameters for updating a private endpoint connection proxy.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointUpdate"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Update private endpoint in private endpoint connection proxy empty response."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyPrivateEndpointUpdate": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_PrivateEndpointUpdate.json"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}/privateEndpointConnectionProxies/{privateEndpointConnectionProxyId}": {
+ "get": {
+ "tags": [
+ "PrivateEndpointConnections"
+ ],
+ "description": "(INTERNAL - DO NOT USE) Get the specified private endpoint connection proxy associated with the device update account.",
+ "operationId": "PrivateEndpointConnectionProxies_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionProxyIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the request was well-formed and received properly.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxy"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyGet": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Get.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "PrivateEndpointConnectionProxies"
+ ],
+ "description": "(INTERNAL - DO NOT USE) Creates or updates the specified private endpoint connection proxy resource associated with the device update account.",
+ "operationId": "PrivateEndpointConnectionProxies_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionProxyIdParameter"
+ },
+ {
+ "name": "privateEndpointConnectionProxy",
+ "in": "body",
+ "description": "The parameters for creating a private endpoint connection proxy.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxy"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxy"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyCreateOrUpdate": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_CreateOrUpdate.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "azure-async-operation"
+ }
+ },
+ "delete": {
+ "tags": [
+ "PrivateEndpointConnectionProxies"
+ ],
+ "description": "(INTERNAL - DO NOT USE) Deletes the specified private endpoint connection proxy associated with the device update account.",
+ "operationId": "PrivateEndpointConnectionProxies_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/AccountNameParameter"
+ },
+ {
+ "$ref": "#/parameters/PrivateEndpointConnectionProxyIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "The request was successful; the operation completed synchronously."
+ },
+ "202": {
+ "description": "The request was successful; the operation will complete asynchronously.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "Operation Status Location URI"
+ }
+ }
+ },
+ "204": {
+ "description": "The private endpoint connection does not exist in the subscription."
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "PrivateEndpointConnectionProxyDelete": {
+ "$ref": "./examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Delete.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.DeviceUpdate/operations": {
+ "get": {
+ "description": "Returns list of operations for Microsoft.DeviceUpdate resource provider.",
+ "operationId": "Operations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Operation details.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing the reason for operation failure.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Gets list of Operations": {
+ "$ref": "./examples/Operations_List.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Account": {
+ "description": "Device Update account details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Device Update account properties.",
+ "x-ms-client-flatten": true,
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Deleted",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Creating"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "hostName": {
+ "description": "API host name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicNetworkAccess": {
+ "description": "Whether or not public network access is allowed for the account.",
+ "default": "Enabled",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicNetworkAccess",
+ "modelAsString": true
+ }
+ },
+ "privateEndpointConnections": {
+ "description": "List of private endpoint connections associated with the account.",
+ "type": "array",
+ "items": {
+ "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection"
+ }
+ },
+ "sku": {
+ "description": "Device Update Sku",
+ "type": "string",
+ "enum": [
+ "Free",
+ "Standard"
+ ],
+ "default": "Standard",
+ "readOnly": false,
+ "x-ms-enum": {
+ "name": "SKU",
+ "modelAsString": true
+ }
+ },
+ "encryption": {
+ "$ref": "#/definitions/Encryption",
+ "description": "CMK encryption at rest properties"
+ },
+ "locations": {
+ "description": "Device Update account primary and failover location details",
+ "readOnly": true,
+ "x-ms-identifiers": [],
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Location"
+ }
+ }
+ }
+ },
+ "identity": {
+ "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
+ "description": "The type of identity used for the resource."
+ }
+ }
+ },
+ "Encryption": {
+ "properties": {
+ "keyVaultKeyUri": {
+ "description": "The URI of the key vault",
+ "type": "string"
+ },
+ "userAssignedIdentity": {
+ "description": "The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account",
+ "type": "string"
+ }
+ },
+ "description": "The CMK encryption settings on the Device Update account."
+ },
+ "Location": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "role": {
+ "description": "Whether the location is primary or failover",
+ "default": "Primary",
+ "enum": [
+ "Primary",
+ "Failover"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Role",
+ "modelAsString": true
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "AccountList": {
+ "description": "List of Accounts.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of Accounts list.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of Accounts.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Account"
+ }
+ }
+ }
+ },
+ "Instance": {
+ "description": "Device Update instance details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Device Update instance properties.",
+ "x-ms-client-flatten": true,
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "description": "Provisioning state.",
+ "type": "string",
+ "enum": [
+ "Succeeded",
+ "Deleted",
+ "Failed",
+ "Canceled",
+ "Accepted",
+ "Creating"
+ ],
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "accountName": {
+ "description": "Parent Device Update Account name which Instance belongs to.",
+ "type": "string",
+ "readOnly": true
+ },
+ "iotHubs": {
+ "description": "List of IoT Hubs associated with the account.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IotHubSettings"
+ }
+ },
+ "enableDiagnostics": {
+ "description": "Enables or Disables the diagnostic logs collection",
+ "type": "boolean"
+ },
+ "diagnosticStorageProperties": {
+ "$ref": "#/definitions/DiagnosticStorageProperties"
+ }
+ }
+ }
+ },
+ "required": [
+ "properties"
+ ]
+ },
+ "DiagnosticStorageProperties": {
+ "description": "Customer-initiated diagnostic log collection storage properties",
+ "type": "object",
+ "properties": {
+ "authenticationType": {
+ "description": "Authentication Type",
+ "enum": [
+ "KeyBased"
+ ],
+ "type": "string",
+ "readOnly": false,
+ "x-ms-enum": {
+ "name": "AuthenticationType",
+ "modelAsString": true
+ }
+ },
+ "connectionString": {
+ "description": "ConnectionString of the diagnostic storage account",
+ "x-ms-secret": true,
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "ResourceId of the diagnostic storage account",
+ "type": "string"
+ }
+ },
+ "required": [
+ "authenticationType",
+ "resourceId"
+ ]
+ },
+ "InstanceList": {
+ "description": "List of Instances.",
+ "type": "object",
+ "properties": {
+ "nextLink": {
+ "description": "The link used to get the next page of Instances list.",
+ "type": "string"
+ },
+ "value": {
+ "description": "List of Instances.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Instance"
+ }
+ }
+ }
+ },
+ "IotHubSettings": {
+ "type": "object",
+ "description": "Device Update account integration with IoT Hub settings.",
+ "properties": {
+ "resourceId": {
+ "description": "IoTHub resource ID",
+ "type": "string",
+ "minLength": 108,
+ "maxLength": 244
+ }
+ },
+ "required": [
+ "resourceId"
+ ]
+ },
+ "AccountUpdate": {
+ "description": "Request payload used to update and existing Accounts.",
+ "type": "object",
+ "properties": {
+ "identity": {
+ "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity",
+ "description": "The type of identity used for the resource."
+ },
+ "location": {
+ "type": "string",
+ "description": "The geo-location where the resource lives"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/TagUpdate"
+ }
+ ]
+ },
+ "TagUpdate": {
+ "description": "Request payload used to update an existing resource's tags.",
+ "type": "object",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "description": "List of key value pairs that describe the resource. This will overwrite the existing tags.",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "PrivateLinkResourceListResult": {
+ "description": "The available private link resources for an Account",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of available private link resources for an Account",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GroupInformation"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private link resources.",
+ "type": "string"
+ }
+ }
+ },
+ "GroupInformation": {
+ "description": "The group information for creating a private endpoint on an Account",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "The properties for a group information object",
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/GroupInformationProperties"
+ }
+ },
+ "required": [
+ "properties"
+ ]
+ },
+ "GroupInformationProperties": {
+ "description": "The properties for a group information object",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./privatelinks.json#/definitions/PrivateLinkResourceProperties"
+ }
+ ],
+ "properties": {
+ "provisioningState": {
+ "description": "The provisioning state of private link group ID.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "GroupIdProvisioningState",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "PrivateEndpointConnectionProxyListResult": {
+ "description": "The available private endpoint connection proxies for an Account (not to be used by anyone, here because of ARM requirements)",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of available private endpoint connection proxies for an Account",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxy"
+ }
+ },
+ "nextLink": {
+ "description": "The URI that can be used to request the next list of private endpoint connection proxies.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateEndpointConnectionProxy": {
+ "description": "Private endpoint connection proxy details.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
+ },
+ {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxyProperties"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Private endpoint connection proxy object property bag.",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "properties": {
+ "provisioningState": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProxyProvisioningState",
+ "description": "The provisioning state of the private endpoint connection proxy resource."
+ }
+ }
+ }
+ }
+ },
+ "PrivateEndpointConnectionProxyProperties": {
+ "description": "Private endpoint connection proxy object properties.",
+ "type": "object",
+ "x-ms-client-flatten": true,
+ "properties": {
+ "eTag": {
+ "description": "ETag from NRP.",
+ "type": "string",
+ "readOnly": true
+ },
+ "remotePrivateEndpoint": {
+ "description": "Remote private endpoint details.",
+ "$ref": "#/definitions/RemotePrivateEndpoint"
+ },
+ "status": {
+ "description": "Operation status.",
+ "type": "string"
+ }
+ }
+ },
+ "RemotePrivateEndpoint": {
+ "description": "Remote private endpoint details.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Remote endpoint resource ID.",
+ "type": "string"
+ },
+ "location": {
+ "description": "ARM location of the remote private endpoint.",
+ "type": "string"
+ },
+ "immutableSubscriptionId": {
+ "description": "Original subscription ID needed by Microsoft.Network.",
+ "type": "string"
+ },
+ "immutableResourceId": {
+ "description": "Original resource ID needed by Microsoft.Network.",
+ "type": "string"
+ },
+ "vnetTrafficTag": {
+ "description": "Virtual network traffic tag.",
+ "type": "string"
+ },
+ "manualPrivateLinkServiceConnections": {
+ "description": "List of private link service connections that need manual approval.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkServiceConnection"
+ }
+ },
+ "privateLinkServiceConnections": {
+ "description": "List of automatically approved private link service connections.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkServiceConnection"
+ }
+ },
+ "privateLinkServiceProxies": {
+ "description": "List of private link service proxies.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkServiceProxy"
+ }
+ },
+ "connectionDetails": {
+ "description": "List of connection details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ConnectionDetails"
+ }
+ }
+ }
+ },
+ "PrivateEndpointUpdate": {
+ "description": "Private endpoint update details.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Remote endpoint resource ID.",
+ "type": "string"
+ },
+ "location": {
+ "description": "ARM location of the remote private endpoint.",
+ "type": "string"
+ },
+ "immutableSubscriptionId": {
+ "description": "Original subscription ID needed by Microsoft.Network.",
+ "type": "string"
+ },
+ "immutableResourceId": {
+ "description": "Original resource ID needed by Microsoft.Network.",
+ "type": "string"
+ },
+ "vnetTrafficTag": {
+ "description": "Virtual network traffic tag.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceConnection": {
+ "description": "Private link service connection details.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Private link service connection name.",
+ "type": "string"
+ },
+ "groupIds": {
+ "description": "List of group IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requestMessage": {
+ "description": "Request message.",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkServiceProxy": {
+ "description": "Private link service proxy details.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "NRP resource ID.",
+ "type": "string"
+ },
+ "remotePrivateLinkServiceConnectionState": {
+ "description": "Remote private link service connection state",
+ "$ref": "./privatelinks.json#/definitions/PrivateLinkServiceConnectionState"
+ },
+ "remotePrivateEndpointConnection": {
+ "description": "Remote private endpoint connection details.",
+ "allOf": [
+ {
+ "$ref": "#/definitions/RemotePrivateEndpointConnection"
+ }
+ ]
+ },
+ "groupConnectivityInformation": {
+ "description": "Group connectivity information.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GroupConnectivityInformation"
+ }
+ }
+ }
+ },
+ "RemotePrivateEndpointConnection": {
+ "description": "Remote private endpoint connection details.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Remote private endpoint connection ID.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "GroupConnectivityInformation": {
+ "description": "Group connectivity details.",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "Group ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "memberName": {
+ "description": "Member name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "customerVisibleFqdns": {
+ "description": "List of customer visible FQDNs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "internalFqdn": {
+ "description": "Internal FQDN.",
+ "type": "string",
+ "readOnly": true
+ },
+ "redirectMapId": {
+ "description": "Redirect map ID.",
+ "type": "string"
+ },
+ "privateLinkServiceArmRegion": {
+ "description": "PrivateLinkService ARM region.",
+ "type": "string"
+ }
+ }
+ },
+ "ConnectionDetails": {
+ "description": "Private endpoint connection proxy object properties.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Connection details ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "privateIpAddress": {
+ "description": "Private IP address.",
+ "type": "string",
+ "readOnly": true
+ },
+ "linkIdentifier": {
+ "description": "Link ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "groupId": {
+ "description": "Group ID.",
+ "type": "string",
+ "readOnly": true
+ },
+ "memberName": {
+ "description": "Member name.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "PrivateEndpointConnectionProxyProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Creating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProxyProvisioningState",
+ "modelAsString": true
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The Azure subscription ID."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "ADU schema API version."
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource group name.",
+ "x-ms-parameter-location": "method"
+ },
+ "AccountNameParameter": {
+ "name": "accountName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Account name.",
+ "x-ms-parameter-location": "method",
+ "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$",
+ "minLength": 3,
+ "maxLength": 24
+ },
+ "InstanceNameParameter": {
+ "name": "instanceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Instance name.",
+ "x-ms-parameter-location": "method",
+ "pattern": "^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$",
+ "minLength": 3,
+ "maxLength": 36
+ },
+ "GroupIdParameter": {
+ "name": "groupId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The group ID of the private link resource.",
+ "x-ms-parameter-location": "method"
+ },
+ "PrivateEndpointConnectionProxyIdParameter": {
+ "name": "privateEndpointConnectionProxyId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the private endpoint connection proxy object.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Create.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Create.json
new file mode 100644
index 000000000000..903bc6072295
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Create.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview",
+ "Account": {
+ "location": "westus2",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
+ }
+ },
+ "properties": {
+ "encryption": {
+ "keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
+ "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "contoso",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
+ "type": "Microsoft.DeviceUpdate/accounts",
+ "identity": {
+ "type": "UserAssigned",
+ "userAssignedIdentities": {
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
+ "principalId": "12345678-1234-4321-1234-123456789012",
+ "clientId": "12345678-4321-1234-1234-123456789012"
+ }
+ }
+ },
+ "properties": {
+ "provisioningState": "Accepted",
+ "hostName": "contoso.api.adu.microsoft.com",
+ "sku": "Free",
+ "encryption": {
+ "keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
+ "userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
+ },
+ "locations": [
+ {
+ "name": "westus2",
+ "role": "Primary"
+ },
+ {
+ "name": "westcentralus",
+ "role": "Failover"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Delete.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Delete.json
new file mode 100644
index 000000000000..0e7c3eeb6855
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Delete.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.DeviceUpdate/locations/westus2/operationStatuses/00000000-0000-0000-0000-000000000000*427E3E07F4C0A3DCD66951C42FD7BCD794AEAC5E321728AFBDCAA7C02E9CD4D3?api-version=2022-12-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Get.json
new file mode 100644
index 000000000000..41d6c8b9cf0f
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Get.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "contoso",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
+ "type": "Microsoft.DeviceUpdate/accounts",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "hostName": "contoso.api.adu.microsoft.com",
+ "sku": "Standard",
+ "locations": [
+ {
+ "name": "westus2",
+ "role": "Primary"
+ },
+ {
+ "name": "westcentralus",
+ "role": "Failover"
+ }
+ ],
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Head.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Head.json
new file mode 100644
index 000000000000..daf1fe1b73a0
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Head.json
@@ -0,0 +1,11 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_List.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_List.json
new file mode 100644
index 000000000000..7cfb0cabb5c8
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_List.json
@@ -0,0 +1,58 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nextLink": "string",
+ "value": [
+ {
+ "name": "contoso",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
+ "type": "Microsoft.DeviceUpdate/accounts",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "hostName": "contoso.api.adu.microsoft.com",
+ "sku": "Standard",
+ "locations": [
+ {
+ "name": "westus2",
+ "role": "Primary"
+ },
+ {
+ "name": "westcentralus",
+ "role": "Failover"
+ }
+ ],
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Update.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Update.json
new file mode 100644
index 000000000000..148f966ee010
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Accounts/Accounts_Update.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview",
+ "accountUpdatePayload": {
+ "tags": {
+ "tagKey": "tagValue"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "contoso",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
+ "type": "Microsoft.DeviceUpdate/accounts",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "hostName": "contoso.api.adu.microsoft.com",
+ "sku": "Standard",
+ "locations": [
+ {
+ "name": "westus2",
+ "role": "Primary"
+ },
+ {
+ "name": "westcentralus",
+ "role": "Failover"
+ }
+ ],
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ ]
+ },
+ "tags": {
+ "tagKey": "tagValue"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "name": "contoso",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
+ "type": "Microsoft.DeviceUpdate/accounts",
+ "identity": {
+ "principalId": "00000000-0000-0000-0000-000000000000",
+ "tenantId": "00000000-0000-0000-0000-000000000000",
+ "type": "SystemAssigned"
+ },
+ "properties": {
+ "provisioningState": "Created",
+ "hostName": "contoso.api.adu.microsoft.com",
+ "sku": "Standard",
+ "locations": [
+ {
+ "name": "westus2",
+ "role": "Primary"
+ },
+ {
+ "name": "westcentralus",
+ "role": "Failover"
+ }
+ ],
+ "privateEndpointConnections": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ ]
+ },
+ "tags": {
+ "tagKey": "tagValue"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_AlreadyExists.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_AlreadyExists.json
new file mode 100644
index 000000000000..1c0ec4a53571
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_AlreadyExists.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01-preview",
+ "request": {
+ "name": "contoso",
+ "type": "Microsoft.DeviceUpdate/accounts"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": false,
+ "reason": "AlreadyExists",
+ "message": "Resource name already exists"
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_Available.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_Available.json
new file mode 100644
index 000000000000..cfad1fea7c2c
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/CheckNameAvailability_Available.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01-preview",
+ "request": {
+ "name": "contoso",
+ "type": "Microsoft.DeviceUpdate/accounts"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nameAvailable": true
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Create.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Create.json
new file mode 100644
index 000000000000..c3ffdbd56a9b
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Create.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "instanceName": "blue",
+ "api-version": "2022-12-01-preview",
+ "Instance": {
+ "location": "westus2",
+ "properties": {
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount",
+ "connectionString": "string"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "name": "blue",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
+ "type": "Microsoft.DeviceUpdate/accounts/instances",
+ "properties": {
+ "provisioningState": "Accepted",
+ "accountName": "contoso",
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Delete.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Delete.json
new file mode 100644
index 000000000000..aaa2ac9acf60
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Delete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "instanceName": "blue",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.DeviceUpdate/locations/westus2/operationStatuses/00000000-0000-0000-0000-000000000000*427E3E07F4C0A3DCD66951C42FD7BCD794AEAC5E321728AFBDCAA7C02E9CD4D3?api-version=2022-12-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Get.json
new file mode 100644
index 000000000000..c8659b8a710f
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Get.json
@@ -0,0 +1,33 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "instanceName": "blue",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "blue",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
+ "type": "Microsoft.DeviceUpdate/accounts/instances",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "accountName": "contoso",
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Head.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Head.json
new file mode 100644
index 000000000000..b67129fd969d
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Head.json
@@ -0,0 +1,12 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "instanceName": "blue",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_ListByAccount.json
new file mode 100644
index 000000000000..d15874d8b040
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_ListByAccount.json
@@ -0,0 +1,57 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nextLink": "string",
+ "value": [
+ {
+ "name": "blue",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
+ "type": "Microsoft.DeviceUpdate/accounts/instances",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "accountName": "contoso",
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
+ }
+ }
+ },
+ {
+ "name": "red",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/red",
+ "type": "Microsoft.DeviceUpdate/accounts/instances",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "accountName": "contoso",
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/red-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Update.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Update.json
new file mode 100644
index 000000000000..c0e6ce4985ee
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Instances/Instances_Update.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "instanceName": "blue",
+ "api-version": "2022-12-01-preview",
+ "tagUpdatePayload": {
+ "tags": {
+ "tagKey": "tagValue"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "blue",
+ "location": "westus2",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/instances/blue",
+ "type": "Microsoft.DeviceUpdate/accounts/instances",
+ "properties": {
+ "accountName": "contoso",
+ "iotHubs": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Devices/IotHubs/blue-contoso-hub"
+ }
+ ],
+ "enableDiagnostics": false,
+ "diagnosticStorageProperties": {
+ "authenticationType": "KeyBased",
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/adu-resource-group/providers/Microsoft.Storage/storageAccounts/testAccount"
+ }
+ },
+ "tags": {
+ "tagKey": "tagValue"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Operations_List.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Operations_List.json
new file mode 100644
index 000000000000..c6540b65f3a4
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/Operations_List.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "nextLink": "string",
+ "value": [
+ {
+ "name": "Microsoft.DeviceUpdate/accounts/read",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.DeviceUpdate",
+ "resource": "Device Update Account",
+ "operation": "Get/List Accounts",
+ "description": "Returns the list of Device Update Accounts"
+ }
+ },
+ {
+ "name": "Microsoft.DeviceUpdate/accounts/write",
+ "isDataAction": false,
+ "display": {
+ "provider": "Microsoft.DeviceUpdate",
+ "resource": "Device Update Account",
+ "operation": "Create/Update Account",
+ "description": "Creates or updates a Device Update Account"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_CreateOrUpdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_CreateOrUpdate.json
new file mode 100644
index 000000000000..6294f326b5d6
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_CreateOrUpdate.json
@@ -0,0 +1,67 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionProxyId": "peexample01",
+ "api-version": "2022-12-01-preview",
+ "privateEndpointConnectionProxy": {
+ "remotePrivateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "manualPrivateLinkServiceConnections": [
+ {
+ "name": "{privateEndpointConnectionProxyId}",
+ "groupIds": [
+ "DeviceUpdate"
+ ],
+ "requestMessage": "Please approve my connection, thanks."
+ }
+ ],
+ "privateLinkServiceProxies": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
+ "groupConnectivityInformation": []
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnectionProxies/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies",
+ "remotePrivateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "manualPrivateLinkServiceConnections": [
+ {
+ "name": "{plsConnectionName}",
+ "groupIds": [
+ "DeviceUpdate"
+ ],
+ "requestMessage": "Please approve my connection, thanks."
+ }
+ ],
+ "privateLinkServiceProxies": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
+ "groupConnectivityInformation": [
+ {
+ "groupId": "DeviceUpdate",
+ "memberName": "adu"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Delete.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Delete.json
new file mode 100644
index 000000000000..fe0a97040b63
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Delete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionProxyId": "peexample01",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.DeviceUpdate/locations/westus2/operationStatuses/00000000-0000-0000-0000-000000000000*427E3E07F4C0A3DCD66951C42FD7BCD794AEAC5E321728AFBDCAA7C02E9CD4D3?api-version=2022-12-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Get.json
new file mode 100644
index 000000000000..182efbc37404
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Get.json
@@ -0,0 +1,44 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionProxyId": "peexample01",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnectionProxies/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies",
+ "remotePrivateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "manualPrivateLinkServiceConnections": [
+ {
+ "name": "{plsConnectionName}",
+ "groupIds": [
+ "DeviceUpdate"
+ ],
+ "requestMessage": "Please approve my connection, thanks."
+ }
+ ],
+ "privateLinkServiceProxies": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
+ "groupConnectivityInformation": [
+ {
+ "groupId": "DeviceUpdate",
+ "memberName": "adu"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_ListByAccount.json
new file mode 100644
index 000000000000..955ff7095669
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_ListByAccount.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnectionProxies/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnectionProxies",
+ "remotePrivateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "manualPrivateLinkServiceConnections": [
+ {
+ "name": "{plsConnectionName}",
+ "groupIds": [
+ "DeviceUpdate"
+ ],
+ "requestMessage": "Please approve my connection, thanks."
+ }
+ ],
+ "privateLinkServiceProxies": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
+ "groupConnectivityInformation": [
+ {
+ "groupId": "DeviceUpdate",
+ "memberName": "adu"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_PrivateEndpointUpdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_PrivateEndpointUpdate.json
new file mode 100644
index 000000000000..9c9f434e9b9c
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_PrivateEndpointUpdate.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionProxyId": "peexample01",
+ "api-version": "2022-12-01-preview",
+ "privateEndpointUpdate": {
+ "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "vnetTrafficTag": "12345678"
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Validate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Validate.json
new file mode 100644
index 000000000000..aa0918c1c237
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnectionProxies/PrivateEndpointConnectionProxy_Validate.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionProxyId": "peexample01",
+ "api-version": "2022-12-01-preview",
+ "privateEndpointConnectionProxy": {
+ "remotePrivateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}",
+ "location": "westus2",
+ "immutableSubscriptionId": "00000000-0000-0000-0000-000000000000",
+ "immutableResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{peName}",
+ "manualPrivateLinkServiceConnections": [
+ {
+ "name": "{privateEndpointConnectionProxyId}",
+ "groupIds": [
+ "DeviceUpdate"
+ ],
+ "requestMessage": "Please approve my connection, thanks."
+ }
+ ],
+ "privateLinkServiceProxies": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/{privateEndpointConnectionProxyId}/privateLinkServiceProxies/{privateEndpointConnectionProxyId}",
+ "groupConnectivityInformation": []
+ }
+ ]
+ }
+ }
+ },
+ "responses": {
+ "200": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json
new file mode 100644
index 000000000000..84db87f68f2d
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionName": "peexample01",
+ "api-version": "2022-12-01-preview",
+ "privateEndpointConnection": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json
new file mode 100644
index 000000000000..d692dc1e6b44
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionName": "peexample01",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {},
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/providers/Microsoft.DeviceUpdate/locations/westus2/operationStatuses/00000000-0000-0000-0000-000000000000*427E3E07F4C0A3DCD66951C42FD7BCD794AEAC5E321728AFBDCAA7C02E9CD4D3?api-version=2022-12-01-preview"
+ }
+ },
+ "204": {}
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json
new file mode 100644
index 000000000000..9c4b3b6b1625
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "privateEndpointConnectionName": "peexample01",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json
new file mode 100644
index 000000000000..8dec95a9d276
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
+ "name": "peexample01",
+ "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Auto-Approved",
+ "actionsRequired": "None"
+ },
+ "groupIds": [
+ "groupId"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json
new file mode 100644
index 000000000000..9e1c5def89e4
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_Get.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "groupId": "adu",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateLinkResources/adu",
+ "name": "adu",
+ "type": "Microsoft.DeviceUpdate/accounts/privateLinkResources",
+ "properties": {
+ "groupId": "adu",
+ "requiredMembers": [
+ "adu"
+ ],
+ "requiredZoneNames": [
+ "privatelink.adu.microsoft.com"
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json
new file mode 100644
index 000000000000..70e184396b2b
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "test-rg",
+ "accountName": "contoso",
+ "api-version": "2022-12-01-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateLinkResources/adu",
+ "name": "adu",
+ "type": "Microsoft.DeviceUpdate/accounts/privateLinkResources",
+ "properties": {
+ "groupId": "adu",
+ "requiredMembers": [
+ "adu"
+ ],
+ "requiredZoneNames": [
+ "privatelink.adu.microsoft.com"
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/privatelinks.json b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/privatelinks.json
new file mode 100644
index 000000000000..1345d0ccd3e5
--- /dev/null
+++ b/specification/deviceupdate/resource-manager/Microsoft.DeviceUpdate/preview/2022-12-01-preview/privatelinks.json
@@ -0,0 +1,179 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2022-12-01-preview",
+ "title": "Common private link types"
+ },
+ "paths": {},
+ "definitions": {
+ "PrivateEndpoint": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ARM identifier for Private Endpoint"
+ }
+ },
+ "description": "The Private Endpoint resource."
+ },
+ "PrivateEndpointConnection": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProperties",
+ "x-ms-client-flatten": true,
+ "description": "Resource properties."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource"
+ }
+ ],
+ "required": [
+ "properties"
+ ],
+ "description": "The Private Endpoint Connection resource."
+ },
+ "PrivateEndpointConnectionProperties": {
+ "type": "object",
+ "properties": {
+ "privateEndpoint": {
+ "$ref": "#/definitions/PrivateEndpoint",
+ "description": "The resource of private end point."
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkServiceConnectionState",
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "groupIds": {
+ "type": "array",
+ "description": "Array of group IDs.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "provisioningState": {
+ "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
+ "description": "The provisioning state of the private endpoint connection resource."
+ }
+ },
+ "required": [
+ "privateLinkServiceConnectionState"
+ ],
+ "description": "Properties of the PrivateEndpointConnectProperties."
+ },
+ "PrivateLinkServiceConnectionState": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus",
+ "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
+ },
+ "description": {
+ "type": "string",
+ "description": "The reason for approval/rejection of the connection."
+ },
+ "actionsRequired": {
+ "type": "string",
+ "description": "A message indicating if changes on the service provider require any updates on the consumer."
+ }
+ },
+ "description": "A collection of information about the state of the connection between service consumer and provider."
+ },
+ "PrivateEndpointServiceConnectionStatus": {
+ "type": "string",
+ "description": "The private endpoint connection status.",
+ "enum": [
+ "Pending",
+ "Approved",
+ "Rejected"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointServiceConnectionStatus",
+ "modelAsString": true
+ }
+ },
+ "PrivateEndpointConnectionProvisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The current provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Creating",
+ "Deleting",
+ "Failed"
+ ],
+ "x-ms-enum": {
+ "name": "PrivateEndpointConnectionProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "PrivateLinkResource": {
+ "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"
+ }
+ }
+ },
+ "description": "List of private endpoint connection associated with the specified storage account"
+ }
+ },
+ "parameters": {
+ "PrivateEndpointConnectionName": {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the private endpoint connection associated with the Azure resource",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/deviceupdate/resource-manager/readme.md b/specification/deviceupdate/resource-manager/readme.md
index b87986784621..eb9e7ef1b9b2 100644
--- a/specification/deviceupdate/resource-manager/readme.md
+++ b/specification/deviceupdate/resource-manager/readme.md
@@ -29,6 +29,14 @@ openapi-type: arm
openapi-subtype: rpaas
tag: package-2022-10-01
```
+### Tag: package-2022-12-01-preview
+
+These settings apply only when `--tag=package-2022-12-01-preview` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12-01-preview'
+input-file:
+ - Microsoft.DeviceUpdate/preview/2022-12-01-preview/deviceupdate.json
+```
### Tag: package-2022-10-01
diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md
index d12ba671f2bd..d8f72adc9cbc 100644
--- a/specification/devspaces/resource-manager/readme.md
+++ b/specification/devspaces/resource-manager/readme.md
@@ -81,15 +81,13 @@ See configuration in [readme.go.md](./readme.go.md)
## Java
These settings apply only when `--java` is specified on the command line.
-Please also specify `--azure-libraries-for-java-folder=`.
``` yaml $(java)
-azure-arm: true
-fluent: true
-namespace: com.microsoft.azure.management.devspaces
-license-header: MICROSOFT_MIT_NO_CODEGEN
-payload-flattening-threshold: 1
-output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devspaces
+directive:
+ - from: swagger-document
+ where: $.definitions.OrchestratorSpecificConnectionDetails
+ transform: >
+ $['required'] = ['instanceType'];
```
### Java multi-api
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/digitaltwins.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/digitaltwins.json
new file mode 100644
index 000000000000..f43a991d8f00
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/digitaltwins.json
@@ -0,0 +1,1953 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2023-02-27-preview",
+ "title": "Azure Digital Twins API",
+ "description": "A service for managing and querying digital twins and digital twin models."
+ },
+ "host": "digitaltwins-hostname",
+ "schemes": [
+ "https"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "paths": {
+ "/models": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Uploads one or more models. When any error occurs, no models are uploaded.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * DTDLParserError - The models provided are not valid DTDL.\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n * ModelVersionNotSupported - The version of DTDL used is not supported.\n* 409 Conflict\n * ModelAlreadyExists - The model provided already exists.",
+ "operationId": "DigitalTwinModels_Add",
+ "x-ms-examples": {
+ "Add models": {
+ "$ref": "./examples/ModelAdd.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "models",
+ "in": "body",
+ "description": "An array of models to add.",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "minItems": 1,
+ "uniqueItems": true,
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/NonPagedDigitalTwinsModelDataCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Retrieves model metadata and, optionally, model definitions.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.\n* 404 Not Found\n * ModelNotFound - The model was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "operationId": "DigitalTwinModels_List",
+ "x-ms-examples": {
+ "List models": {
+ "$ref": "./examples/ModelsGet.json"
+ },
+ "List models (include dependencies and definitions)": {
+ "$ref": "./examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "dependenciesFor",
+ "in": "query",
+ "description": "If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved.",
+ "required": false,
+ "type": "array",
+ "collectionFormat": "multi",
+ "items": {
+ "type": "string"
+ }
+ },
+ {
+ "$ref": "#/parameters/includeModelDefinition"
+ },
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/PagedDigitalTwinsModelDataCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/models/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Retrieves model metadata and optionally the model definition.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.",
+ "operationId": "DigitalTwinModels_GetById",
+ "x-ms-examples": {
+ "Get a model by id": {
+ "$ref": "./examples/ModelGetById.json"
+ },
+ "Get a model by id (with definition)": {
+ "$ref": "./examples/ModelGetByIdWithIncludeModelDefinition.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "$ref": "#/parameters/includeModelDefinition"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Models"
+ ],
+ "description": "Updates the metadata for a model.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned.",
+ "operationId": "DigitalTwinModels_Update",
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "x-ms-examples": {
+ "Decommission a model": {
+ "$ref": "./examples/ModelUpdateDecommissioned.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "name": "updateModel",
+ "description": "An update specification described by JSON Patch. Only the decommissioned property can be replaced.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Models"
+ ],
+ "operationId": "DigitalTwinModels_Delete",
+ "description": "Deletes a model. A model can only be deleted if no other models reference it.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The model id is invalid.\n * MissingArgument - The model id was not provided.\n* 404 Not Found\n * ModelNotFound - The model was not found.\n* 409 Conflict\n * ModelReferencesNotDeleted - The model refers to models that are not deleted.",
+ "x-ms-examples": {
+ "Delete a model": {
+ "$ref": "./examples/DeleteModel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/modelId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/query": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Query"
+ ],
+ "operationId": "Query_QueryTwins",
+ "description": "Executes a query that allows traversing relationships and filtering by property values.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * BadRequest - The continuation token is invalid.\n * SqlQueryError - The query contains some errors.\n * TimeoutError - The query execution timed out after 60 seconds. Try simplifying the query or adding conditions to reduce the result size.\n * 429 Too Many Requests\n * QuotaReachedError - The maximum query rate limit has been reached.",
+ "x-ms-examples": {
+ "Query for digital twins": {
+ "$ref": "./examples/QueryFirstPage.json"
+ },
+ "Retrieve paged query results": {
+ "$ref": "./examples/QueryNextPage.json"
+ },
+ "Query for digital twins through a relationship": {
+ "$ref": "./examples/QueryJoin.json"
+ }
+ },
+ "parameters": [
+ {
+ "name": "querySpecification",
+ "in": "body",
+ "description": "The query specification to execute.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/QuerySpecification"
+ }
+ },
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/QueryResult"
+ },
+ "headers": {
+ "query-charge": {
+ "description": "The query charge.",
+ "type": "number"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetById",
+ "description": "Retrieves a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-examples": {
+ "Get a digital twin by id": {
+ "$ref": "./examples/GetTwin.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DigitalTwin"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Add",
+ "description": "Adds or replaces a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * ModelDecommissioned - The model for the digital twin is decommissioned.\n * TwinLimitReached - The maximum number of digital twins allowed has been reached.\n * ValidationFailed - The digital twin payload is not valid.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Add a digital twin": {
+ "$ref": "./examples/PutTwinBasicExample.json"
+ },
+ "Add a digital twin (with properties and components)": {
+ "$ref": "./examples/PutTwinAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "twin",
+ "description": "The digital twin instance being added. If provided, the $dtId property is ignored.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "$ref": "#/parameters/if-none-match-star"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/DigitalTwin"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Delete",
+ "description": "Deletes a digital twin. All relationships referencing the digital twin must already be deleted.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n * RelationshipsNotDeleted - The digital twin contains relationships.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Delete a digital twin": {
+ "$ref": "./examples/DeleteTwin.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_Update",
+ "description": "Updates a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "x-ms-examples": {
+ "Update a digital twin": {
+ "$ref": "./examples/PatchTwinBasicExample.json"
+ },
+ "Update a digital twin (multiple updates)": {
+ "$ref": "./examples/PatchTwinAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "patchDocument",
+ "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/relationships/{relationshipId}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetRelationshipById",
+ "description": "Retrieves a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.",
+ "x-ms-examples": {
+ "Get a relationship by id": {
+ "$ref": "./examples/GetRelationshipById.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/Relationship"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_AddRelationship",
+ "description": "Adds a relationship between two digital twins.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id, relationship id, or payload is invalid.\n * InvalidRelationship - The relationship is invalid.\n * OperationNotAllowed - The relationship cannot connect to the same digital twin.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * TargetTwinNotFound - The digital twin target of the relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Create a relationship": {
+ "$ref": "./examples/CreateRelationshipBasicExample.json"
+ },
+ "Create a relationship (with properties)": {
+ "$ref": "./examples/CreateRelationshipAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "name": "relationship",
+ "in": "body",
+ "description": "The data for the relationship.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "$ref": "#/parameters/if-none-match-star"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/Relationship"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_DeleteRelationship",
+ "description": "Deletes a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Delete a relationship": {
+ "$ref": "./examples/DeleteRelationship.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "operationId": "DigitalTwins_UpdateRelationship",
+ "description": "Updates the properties on a relationship between two digital twins.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or relationship id is invalid.\n * InvalidRelationship - The relationship is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - The relationship content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * RelationshipNotFound - The relationship was not found.\n* 409 Conflict\n * RelationshipAlreadyExists - The relationship already exists.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Update relationship properties": {
+ "$ref": "./examples/PatchRelationshipBasicExample.json"
+ },
+ "Update relationship properties (multiple updates)": {
+ "$ref": "./examples/PatchRelationshipAdvancedExample.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/relationshipId"
+ },
+ {
+ "name": "patchDocument",
+ "description": "JSON Patch description of the update to the relationship properties.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/relationships": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_ListRelationships",
+ "description": "Retrieves the relationships from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List relationships": {
+ "$ref": "./examples/GetRelationship.json"
+ },
+ "List relationships by name": {
+ "$ref": "./examples/GetRelationshipByRelationshipName.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "relationshipName",
+ "description": "The name of the relationship.",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/RelationshipCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/incomingrelationships": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_ListIncomingRelationships",
+ "description": "Retrieves all incoming relationship for a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "List incoming relationships": {
+ "$ref": "./examples/GetIncomingRelationship.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/IncomingRelationshipCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/telemetry": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_SendTelemetry",
+ "description": "Sends telemetry on behalf of a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id or message id is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.",
+ "x-ms-examples": {
+ "Send telemetry": {
+ "$ref": "./examples/SendTelemetry.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "name": "telemetry",
+ "in": "body",
+ "description": "The telemetry measurements to send from the digital twin.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "name": "Message-Id",
+ "in": "header",
+ "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Telemetry-Source-Time",
+ "in": "header",
+ "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/components/{componentPath}/telemetry": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_SendComponentTelemetry",
+ "description": "Sends telemetry on behalf of a component in a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, message id, or component path is invalid.\n * ValidationFailed - The telemetry content is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.",
+ "x-ms-examples": {
+ "Send telemetry in a component": {
+ "$ref": "./examples/SendTelemetryFromComponent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "name": "telemetry",
+ "in": "body",
+ "description": "The telemetry measurements to send from the digital twin's component.",
+ "required": true,
+ "schema": {
+ "type": "object"
+ }
+ },
+ {
+ "name": "Message-Id",
+ "in": "header",
+ "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "Telemetry-Source-Time",
+ "in": "header",
+ "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/digitaltwins/{id}/components/{componentPath}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_GetComponent",
+ "description": "Retrieves a component from a digital twin.\nStatus codes:\n* 200 OK\n* 400 Bad Request\n * InvalidArgument - The digital twin id or component path is invalid.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n * ComponentNotFound - The component path was not found.",
+ "x-ms-examples": {
+ "Get a component in a digital twin": {
+ "$ref": "./examples/GetComponent.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/Component"
+ },
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Twins"
+ ],
+ "operationId": "DigitalTwins_UpdateComponent",
+ "description": "Updates a component on a digital twin.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * InvalidArgument - The digital twin id, component path, or payload is invalid.\n * JsonPatchInvalid - The JSON Patch provided is invalid.\n * ValidationFailed - Applying the patch results in an invalid digital twin.\n* 404 Not Found\n * DigitalTwinNotFound - The digital twin was not found.\n* 412 Precondition Failed\n * PreconditionFailed - The precondition check (If-Match or If-None-Match) failed.",
+ "x-ms-examples": {
+ "Update a component in a digital twin": {
+ "$ref": "./examples/PatchComponentBasicExample.json"
+ },
+ "Update a component in a digital twin (multiple updates)": {
+ "$ref": "./examples/PatchComponentAdvancedExample.json"
+ }
+ },
+ "consumes": [
+ "application/json-patch+json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/digitalTwinId"
+ },
+ {
+ "$ref": "#/parameters/componentPath"
+ },
+ {
+ "name": "patchDocument",
+ "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "$ref": "#/parameters/if-match"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success",
+ "headers": {
+ "ETag": {
+ "description": "Weak Etag.",
+ "type": "string"
+ }
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/eventroutes": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Retrieves all event routes.\nStatus codes:\n* 200 OK",
+ "operationId": "EventRoutes_List",
+ "x-ms-examples": {
+ "List event routes": {
+ "$ref": "./examples/EventRoutesList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/EventRouteCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/eventroutes/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Retrieves an event route.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.",
+ "operationId": "EventRoutes_GetById",
+ "x-ms-examples": {
+ "Get an event route by id": {
+ "$ref": "./examples/EventRouteGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Adds or replaces an event route.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * EventRouteEndpointInvalid - The endpoint provided does not exist or is not active.\n * EventRouteFilterInvalid - The event route filter is invalid.\n * EventRouteIdInvalid - The event route id is invalid.\n * LimitExceeded - The maximum number of event routes allowed has been reached.",
+ "operationId": "EventRoutes_Add",
+ "x-ms-examples": {
+ "Add an event route": {
+ "$ref": "./examples/EventRoutePut.json"
+ },
+ "Add an event route (with filter)": {
+ "$ref": "./examples/EventRoutePutWithFilter.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "name": "eventRoute",
+ "description": "The event route data",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "EventRoutes"
+ ],
+ "description": "Deletes an event route.\nStatus codes:\n* 204 No Content\n* 404 Not Found\n * EventRouteNotFound - The event route was not found.",
+ "operationId": "EventRoutes_Delete",
+ "x-ms-examples": {
+ "Delete an event route": {
+ "$ref": "./examples/EventRouteDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/eventRouteId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/jobs/imports": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "get": {
+ "tags": [
+ "ImportJobs"
+ ],
+ "operationId": "ImportJobs_List",
+ "description": "Retrieves all bulk import jobs.\nStatus codes:\n* 200 OK",
+ "x-ms-examples": {
+ "Get all bulk jobs": {
+ "$ref": "./examples/BulkImportJobList.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/max-items-per-page"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BulkImportJobCollection"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/jobs/imports/{id}": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "put": {
+ "tags": [
+ "ImportJobs"
+ ],
+ "operationId": "ImportJobs_Add",
+ "description": "Creates a bulk import job.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of bulk import jobs allowed has been reached.\n * ValidationFailed - The bulk job request is not valid.",
+ "x-ms-examples": {
+ "Add a job": {
+ "$ref": "./examples/BulkImportJobPut.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/bulkImportJobId"
+ },
+ {
+ "name": "importJob",
+ "description": "The bulk import job being added.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BulkImportJob"
+ }
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BulkImportJob"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ImportJobs"
+ ],
+ "operationId": "ImportJobs_GetById",
+ "description": "Retrieves a bulk job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * BulkJobNotFound - The bulk job was not found.",
+ "x-ms-examples": {
+ "Get a bulk job by id": {
+ "$ref": "./examples/BulkImportJobGet.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/bulkImportJobId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BulkImportJob"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ImportJobs"
+ ],
+ "operationId": "ImportJobs_Delete",
+ "description": "Deletes a bulk import job.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The bulk job request is not valid.",
+ "x-ms-examples": {
+ "Delete a bulk job": {
+ "$ref": "./examples/BulkImportJobDelete.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/bulkImportJobId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Success"
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/jobs/imports/{id}/cancel": {
+ "parameters": [
+ {
+ "$ref": "#/parameters/traceparent"
+ },
+ {
+ "$ref": "#/parameters/tracestate"
+ }
+ ],
+ "post": {
+ "tags": [
+ "ImportJobs"
+ ],
+ "operationId": "ImportJobs_Cancel",
+ "description": "Cancels a bulk import job.\nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The bulk job request is not valid.",
+ "x-ms-examples": {
+ "Cancel a job": {
+ "$ref": "./examples/BulkImportJobCancel.json"
+ }
+ },
+ "parameters": [
+ {
+ "$ref": "#/parameters/bulkImportJobId"
+ },
+ {
+ "$ref": "#/parameters/api-version"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "schema": {
+ "$ref": "#/definitions/BulkImportJob"
+ }
+ },
+ "default": {
+ "description": "Default response.",
+ "schema": {
+ "$ref": "#/definitions/ErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DigitalTwin": {
+ "description": "Digital twin",
+ "type": "object",
+ "additionalProperties": {}
+ },
+ "Relationship": {
+ "description": "Digital twin relationship",
+ "type": "object",
+ "additionalProperties": {}
+ },
+ "Component": {
+ "description": "Digital twin component",
+ "type": "object",
+ "additionalProperties": {}
+ },
+ "EventRoute": {
+ "description": "A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.",
+ "type": "object",
+ "required": [
+ "endpointName",
+ "filter"
+ ],
+ "properties": {
+ "id": {
+ "description": "The id of the event route.",
+ "type": "string",
+ "readOnly": true
+ },
+ "endpointName": {
+ "description": "The name of the endpoint this event route is bound to.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "An expression which describes the events which are routed to the endpoint.",
+ "type": "string"
+ }
+ }
+ },
+ "EventRouteCollection": {
+ "description": "A collection of EventRoute objects.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The EventRoute objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EventRoute"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "NonPagedDigitalTwinsModelDataCollection": {
+ "description": "A collection of DigitalTwinsModelData objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "PagedDigitalTwinsModelDataCollection": {
+ "description": "A collection of DigitalTwinsModelData objects.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The DigitalTwinsModelData objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DigitalTwinsModelData"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of objects.",
+ "type": "string"
+ }
+ }
+ },
+ "DigitalTwinsModelData": {
+ "description": "A model definition and metadata for that model.",
+ "required": [
+ "id"
+ ],
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "A language map that contains the localized display names as specified in the model definition.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "A language map that contains the localized descriptions as specified in the model definition.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "description": "The id of the model as specified in the model definition.",
+ "type": "string"
+ },
+ "uploadTime": {
+ "description": "The time the model was uploaded to the service.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "decommissioned": {
+ "description": "Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.",
+ "type": "boolean",
+ "default": false
+ },
+ "model": {
+ "description": "The model definition.",
+ "type": "object"
+ }
+ }
+ },
+ "RelationshipCollection": {
+ "description": "A collection of relationships which relate digital twins together.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The relationship objects.",
+ "type": "array",
+ "items": {
+ "description": "The relationship JSON document.",
+ "type": "object"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of objects.",
+ "type": "string"
+ }
+ }
+ },
+ "IncomingRelationshipCollection": {
+ "description": "A collection of incoming relationships which relate digital twins together.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IncomingRelationship"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "A URI to retrieve the next page of objects."
+ }
+ }
+ },
+ "IncomingRelationship": {
+ "type": "object",
+ "description": "An incoming relationship.",
+ "properties": {
+ "$relationshipId": {
+ "type": "string",
+ "description": "A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service."
+ },
+ "$sourceId": {
+ "type": "string",
+ "description": "The id of the source digital twin."
+ },
+ "$relationshipName": {
+ "type": "string",
+ "description": "The name of the relationship."
+ },
+ "$relationshipLink": {
+ "type": "string",
+ "description": "Link to the relationship, to be used for deletion."
+ }
+ }
+ },
+ "QuerySpecification": {
+ "description": "A query specification containing either a query statement or a continuation token from a previous query result.",
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "The query to execute. This value is ignored if a continuation token is provided.",
+ "type": "string"
+ },
+ "continuationToken": {
+ "description": "A token which is used to retrieve the next set of results from a previous query.",
+ "type": "string"
+ }
+ }
+ },
+ "QueryResult": {
+ "description": "The results of a query operation and an optional continuation token.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The query results.",
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "continuationToken": {
+ "description": "A token which can be used to construct a new QuerySpecification to retrieve the next set of results.",
+ "type": "string"
+ }
+ }
+ },
+ "BulkImportJob": {
+ "description": "A job which contains a reference to the operations to perform, results, and execution metadata.",
+ "type": "object",
+ "required": [
+ "inputBlobUri",
+ "outputBlobUri"
+ ],
+ "properties": {
+ "id": {
+ "description": "The identifier of the bulk import job.",
+ "type": "string",
+ "readOnly": true
+ },
+ "inputBlobUri": {
+ "description": "The path to the input Azure storage blob that contains file(s) describing the operations to perform in the job.",
+ "type": "string"
+ },
+ "outputBlobUri": {
+ "description": "The path to the output Azure storage blob that will contain the errors and progress logs of import job.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the job.",
+ "enum": [
+ "notstarted",
+ "running",
+ "failed",
+ "succeeded",
+ "cancelling",
+ "cancelled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "status",
+ "modelAsExtensible": true,
+ "modelAsString": false
+ }
+ },
+ "createdDateTime": {
+ "description": "Start time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "lastActionDateTime": {
+ "description": "Last time service performed any action from the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "finishedDateTime": {
+ "description": "End time of the job. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "purgeDateTime": {
+ "description": "Time at which job will be purged by the service from the system. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "Details of the error(s) that occurred executing the bulk job."
+ }
+ }
+ },
+ "BulkImportJobCollection": {
+ "description": "A collection of bulk import job objects.",
+ "type": "object",
+ "required": [
+ "value"
+ ],
+ "properties": {
+ "value": {
+ "description": "The list of bulk import job objects.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BulkImportJob"
+ }
+ },
+ "nextLink": {
+ "description": "A URI to retrieve the next page of results.",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorResponse": {
+ "description": "Error response.",
+ "required": [
+ "error"
+ ],
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/Error",
+ "description": "The error details."
+ }
+ }
+ },
+ "Error": {
+ "description": "Error definition.",
+ "properties": {
+ "code": {
+ "description": "Service specific error code which serves as the substatus for the HTTP error code.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "A human-readable representation of the error.",
+ "type": "string",
+ "readOnly": true
+ },
+ "details": {
+ "description": "Internal error details.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Error"
+ },
+ "readOnly": true
+ },
+ "innererror": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerError"
+ }
+ }
+ },
+ "InnerError": {
+ "description": "A more specific error description than was provided by the containing error.",
+ "properties": {
+ "code": {
+ "description": "A more specific error code than was provided by the containing error.",
+ "type": "string"
+ },
+ "innererror": {
+ "description": "An object containing more specific information than the current object about the error.",
+ "$ref": "#/definitions/InnerError"
+ }
+ }
+ }
+ },
+ "securityDefinitions": {
+ "oauth2": {
+ "flow": "implicit",
+ "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0",
+ "type": "oauth2"
+ }
+ },
+ "parameters": {
+ "eventRouteId": {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The id for an event route. The id is unique within event routes and case sensitive.",
+ "x-ms-parameter-location": "method"
+ },
+ "includeModelDefinition": {
+ "name": "includeModelDefinition",
+ "description": "When true the model definition will be returned as part of the result.",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": false,
+ "x-ms-parameter-location": "method"
+ },
+ "digitalTwinId": {
+ "name": "id",
+ "in": "path",
+ "description": "The id of the digital twin. The id is unique within the service and case sensitive.",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method"
+ },
+ "modelId": {
+ "name": "id",
+ "in": "path",
+ "description": "The id for the model. The id is globally unique and case sensitive.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "relationshipId": {
+ "name": "relationshipId",
+ "description": "The id of the relationship. The id is unique within the digital twin and case sensitive.",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "bulkImportJobId": {
+ "name": "id",
+ "in": "path",
+ "description": "The id for the bulk import job. The id is unique within the service and case sensitive.",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "componentPath": {
+ "name": "componentPath",
+ "in": "path",
+ "description": "The name of the DTDL component.",
+ "type": "string",
+ "required": true,
+ "x-ms-parameter-location": "method"
+ },
+ "api-version": {
+ "name": "api-version",
+ "in": "query",
+ "description": "The requested API version.",
+ "required": true,
+ "type": "string",
+ "minLength": 1
+ },
+ "max-items-per-page": {
+ "name": "max-items-per-page",
+ "in": "header",
+ "description": "The maximum number of items to retrieve per request. The server may choose to return less than the requested number.",
+ "required": false,
+ "type": "integer",
+ "x-ms-client-name": "MaxItemsPerPage",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "if-none-match-star": {
+ "name": "If-None-Match",
+ "in": "header",
+ "description": "Only perform the operation if the entity does not already exist.",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "*"
+ ],
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "if-match": {
+ "name": "If-Match",
+ "in": "header",
+ "description": "Only perform the operation if the entity's etag matches one of the etags provided or * is provided.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "traceparent": {
+ "name": "traceparent",
+ "in": "header",
+ "description": "Identifies the request in a distributed tracing system.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ },
+ "tracestate": {
+ "name": "tracestate",
+ "in": "header",
+ "description": "Provides vendor-specific trace identification information and is a companion to traceparent.",
+ "required": false,
+ "type": "string",
+ "x-ms-parameter-location": "method",
+ "x-ms-parameter-grouping": {
+ "postfix": "Options"
+ }
+ }
+ },
+ "security": [
+ {
+ "oauth2": []
+ }
+ ]
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobCancel.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobCancel.json
new file mode 100644
index 000000000000..cfbcdb6d9425
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobCancel.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "bulkimportjob1"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "bulkimportjob1",
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob",
+ "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
+ "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "finishedDateTime": null,
+ "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
+ "status": "cancelling"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobDelete.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobDelete.json
new file mode 100644
index 000000000000..2d3898e1a86c
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobDelete.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "id": "bulkimportjob1",
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobGet.json
new file mode 100644
index 000000000000..014e9e9fd0db
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobGet.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "id": "bulkimportjob1",
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "bulkimportjob1",
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob",
+ "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
+ "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
+ "status": "succeeded"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobList.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobList.json
new file mode 100644
index 000000000000..bf6bd17a2aeb
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobList.json
@@ -0,0 +1,34 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "bulkimportjob1",
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob",
+ "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
+ "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
+ "status": "succeeded"
+ },
+ {
+ "id": "bulkimportjob2",
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob",
+ "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
+ "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
+ "status": "succeeded"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobPut.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobPut.json
new file mode 100644
index 000000000000..20ce8a8ff7db
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobPut.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "bulkimportjob1",
+ "importJob": {
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob"
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "bulkimportjob1",
+ "inputBlobUri": "path to input blob",
+ "outputBlobUri": "path to output blob",
+ "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
+ "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
+ "finishedDateTime": null,
+ "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
+ "status": "notstarted"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipAdvancedExample.json
new file mode 100644
index 000000000000..02a4144e1317
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipAdvancedExample.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId",
+ "relationship": {
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "relationshipProperty1": 1,
+ "relationshipProperty2": "some value"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "relationshipProperty1": 1,
+ "relationshipProperty2": "some value",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipBasicExample.json
new file mode 100644
index 000000000000..6c6526459134
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/CreateRelationshipBasicExample.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId",
+ "relationship": {
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship"
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteModel.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteModel.json
new file mode 100644
index 000000000000..b9722d63546b
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteModel.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "dtmi:com:example:Sample;1"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteRelationship.json
new file mode 100644
index 000000000000..064b5f6df74d
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteRelationship.json
@@ -0,0 +1,10 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteTwin.json
new file mode 100644
index 000000000000..0bb5edfddc0d
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/DeleteTwin.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteDelete.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteDelete.json
new file mode 100644
index 000000000000..537d17117b54
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteDelete.json
@@ -0,0 +1,9 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteGet.json
new file mode 100644
index 000000000000..53ff9dd5179a
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRouteGet.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "eventroute-001",
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePut.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePut.json
new file mode 100644
index 000000000000..27b5ccfa6865
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePut.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "eventRoute": {
+ "endpointName": "endpoint-001",
+ "filter": "true"
+ },
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePutWithFilter.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePutWithFilter.json
new file mode 100644
index 000000000000..51324860fb80
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutePutWithFilter.json
@@ -0,0 +1,13 @@
+{
+ "parameters": {
+ "id": "eventroute-001",
+ "eventRoute": {
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ },
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutesList.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutesList.json
new file mode 100644
index 000000000000..14007bf273d4
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/EventRoutesList.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "eventroute-001",
+ "endpointName": "endpoint-001",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'"
+ },
+ {
+ "id": "eventroute-002",
+ "endpointName": "endpoint-002",
+ "filter": "type = 'Microsoft.DigitalTwins.Twin.Create' OR type = 'microsoft.iot.telemetry'"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetComponent.json
new file mode 100644
index 000000000000..a2c41f03861e
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetComponent.json
@@ -0,0 +1,36 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "componentPath": "myComponent"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "componentProperty": "some value",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "componentProperty": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ },
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "property1": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "property2": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetIncomingRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetIncomingRelationship.json
new file mode 100644
index 000000000000..381be5902b68
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetIncomingRelationship.json
@@ -0,0 +1,27 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$relationshipName": "myRelationship",
+ "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/firstRelationshipId"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$relationshipName": "myRelationship",
+ "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/secondRelationshipId"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationship.json
new file mode 100644
index 000000000000..6aad0d2eebfc
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationship.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "property": "value"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
+ "property": "value"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipById.json
new file mode 100644
index 000000000000..e0a262ad8ea0
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipById.json
@@ -0,0 +1,19 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin",
+ "relationshipId": "myRelationshipId"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$relationshipId": "myRelationshipId",
+ "$sourceId": "mySourceTwin",
+ "$targetId": "myTargetTwin",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "relationshipProperty": "some value"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipByRelationshipName.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipByRelationshipName.json
new file mode 100644
index 000000000000..608a534eaa61
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetRelationshipByRelationshipName.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "mySourceTwin",
+ "relationshipName": "myRelationship"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "firstRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"1553dbf5-0052-4be8-bea8-46269075b503\"",
+ "property": "value"
+ },
+ {
+ "$sourceId": "mySourceTwin",
+ "$relationshipId": "secondRelationshipId",
+ "$targetId": "targetTwinId",
+ "$relationshipName": "myRelationship",
+ "$etag": "W/\"2552a0a7-0666-4d5e-a67f-ece5b9b81fe0\"",
+ "property": "value"
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetTwin.json
new file mode 100644
index 000000000000..7d7af6eeb38f
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/GetTwin.json
@@ -0,0 +1,38 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myTwinId",
+ "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "componentProperty": "some value",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "componentProperty": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ },
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "property1": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "property2": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelAdd.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelAdd.json
new file mode 100644
index 000000000000..cda6db7c4b12
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelAdd.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "models": [
+ {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "displayName": "Sample Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ ],
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "201": {
+ "body": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "displayName": {
+ "en": "Sample Interface"
+ },
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetById.json
new file mode 100644
index 000000000000..7d375890b88b
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetById.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetByIdWithIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetByIdWithIncludeModelDefinition.json
new file mode 100644
index 000000000000..35e9e9872494
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelGetByIdWithIncludeModelDefinition.json
@@ -0,0 +1,41 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "includeModelDefinition": true,
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelUpdateDecommissioned.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelUpdateDecommissioned.json
new file mode 100644
index 000000000000..507b2f06da1e
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelUpdateDecommissioned.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "id": "dtmi:com:example:Sample;1",
+ "updateModel": [
+ {
+ "op": "replace",
+ "path": "/decommissioned",
+ "value": true
+ }
+ ],
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGet.json
new file mode 100644
index 000000000000..46be90685b90
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGet.json
@@ -0,0 +1,35 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false
+ },
+ {
+ "id": "dtmi:com:example:SampleDeviceModel;1",
+ "displayName": {
+ "en": "My Device Model"
+ },
+ "uploadTime": "2022-02-27T00:30:00.1234567Z",
+ "decommissioned": false
+ },
+ {
+ "id": "dtmi:com:example:AnotherSample;1",
+ "displayName": {
+ "en": "My Sample"
+ },
+ "uploadTime": "2022-02-26T00:30:00.1234567Z",
+ "decommissioned": false
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json
new file mode 100644
index 000000000000..e3540eede388
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json
@@ -0,0 +1,70 @@
+{
+ "parameters": {
+ "includeModelDefinition": true,
+ "dependenciesFor": [
+ "dtmi:com:example:SampleDeviceModel;1"
+ ],
+ "x-ms-max-item-count": 20,
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "dtmi:com:example:Sample;1",
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:Sample;1",
+ "@type": "Interface",
+ "contents": [
+ {
+ "@type": "Property",
+ "name": "name",
+ "displayName": "Sample instance name",
+ "schema": "string"
+ },
+ {
+ "@type": "Property",
+ "name": "temp",
+ "displayName": "Sample instance temperature",
+ "schema": "integer"
+ },
+ {
+ "@type": "Property",
+ "name": "comfortIndex",
+ "displayName": "Sample instance comfort index",
+ "schema": "integer"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ },
+ {
+ "id": "dtmi:com:example:SampleDeviceModel;1",
+ "displayName": {
+ "en": "My Device Model"
+ },
+ "uploadTime": "2022-02-28T00:30:00.1234567Z",
+ "decommissioned": false,
+ "model": {
+ "@id": "dtmi:com:example:SampleDeviceModel;1",
+ "@type": "Interface",
+ "displayName": "My Device Model",
+ "contents": [
+ {
+ "@type": "Component",
+ "name": "Sample",
+ "schema": "dtmi:com:example:Sample;1"
+ }
+ ],
+ "@context": "dtmi:dtdl:context;2"
+ }
+ }
+ ],
+ "nextLink": "url-to-next-page"
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentAdvancedExample.json
new file mode 100644
index 000000000000..d5ce9dc33bd6
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentAdvancedExample.json
@@ -0,0 +1,31 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "replace",
+ "path": "/$metadata/property1/sourceTime",
+ "value": "2022-05-31T12:00:01.000125009Z"
+ },
+ {
+ "op": "remove",
+ "path": "/property2"
+ },
+ {
+ "op": "replace",
+ "path": "/property3/subProperty1",
+ "value": "new value"
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentBasicExample.json
new file mode 100644
index 000000000000..929d8e14402e
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchComponentBasicExample.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipAdvancedExample.json
new file mode 100644
index 000000000000..071965bdf850
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipAdvancedExample.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "remove",
+ "path": "/property2"
+ },
+ {
+ "op": "replace",
+ "path": "/property3/subProperty1",
+ "value": "new value"
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipBasicExample.json
new file mode 100644
index 000000000000..d60d9b8153da
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchRelationshipBasicExample.json
@@ -0,0 +1,17 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "relationshipId": "myRelationshipId",
+ "patchDocument": [
+ {
+ "op": "add",
+ "path": "/property",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinAdvancedExample.json
new file mode 100644
index 000000000000..9164ab9c24e6
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinAdvancedExample.json
@@ -0,0 +1,30 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myNewTwinId",
+ "patchDocument": [
+ {
+ "op": "replace",
+ "path": "/property1",
+ "value": 1
+ },
+ {
+ "op": "replace",
+ "path": "/$metadata/property1/sourceTime",
+ "value": "2022-05-31T12:00:01.000125009Z"
+ },
+ {
+ "op": "add",
+ "path": "/property2/subProperty1",
+ "value": 1
+ },
+ {
+ "op": "remove",
+ "path": "/property3"
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinBasicExample.json
new file mode 100644
index 000000000000..419e169d2260
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PatchTwinBasicExample.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myNewTwinId",
+ "patchDocument": [
+ {
+ "op": "replace",
+ "path": "/property1",
+ "value": 1
+ }
+ ]
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinAdvancedExample.json
new file mode 100644
index 000000000000..0d6982cbc182
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinAdvancedExample.json
@@ -0,0 +1,62 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myNewTwinId",
+ "If-None-Match": "*",
+ "twin": {
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "property1": {
+ "sourceTime": "2022-05-31T12:00:01.000125009Z"
+ }
+ },
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "$metadata": {
+ "componentProperty": {
+ "sourceTime": "2022-05-31T12:00:00.000125009Z"
+ }
+ },
+ "componentProperty": "some value"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myNewTwinId",
+ "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
+ "property1": 1,
+ "property2": {
+ "subProperty1": "some value",
+ "subProperty2": "some other value"
+ },
+ "component1": {
+ "componentProperty": "some value",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "componentProperty": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "sourceTime": "2022-05-31T12:00:01.000125009Z"
+ }
+ }
+ },
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "property1": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "sourceTime": "2022-05-31T12:00:01.000125009Z"
+ },
+ "property2": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinBasicExample.json
new file mode 100644
index 000000000000..733fe46f41bb
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/PutTwinBasicExample.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myNewTwinId",
+ "twin": {
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "$dtId": "myNewTwinId",
+ "$metadata": {
+ "$model": "dtmi:com:example:interfaces:interfaceName;1",
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryFirstPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryFirstPage.json
new file mode 100644
index 000000000000..25b68e874100
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryFirstPage.json
@@ -0,0 +1,75 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "query": "SELECT * FROM DIGITALTWINS WHERE temp = 79"
+ },
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-02",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:29:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:29:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:29:00.1234567Z",
+ "sourceTime": "2022-05-31T12:00:00.000125009Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:29:00.1234567Z"
+ }
+ },
+ "name": "Sample02",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-03",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:31:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:31:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:31:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:31:00.1234567Z"
+ }
+ },
+ "name": "Sample03",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ ],
+ "continuationToken": ""
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryJoin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryJoin.json
new file mode 100644
index 000000000000..cd76341f82d5
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryJoin.json
@@ -0,0 +1,96 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "query": "SELECT Widget, Gadget FROM DIGITALTWINS Widget JOIN Gadget RELATED Widget.Contains WHERE Widget.$dtId = 'Twin-01'"
+ },
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "Widget": {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ "Gadget": {
+ "$dtId": "Twin-02",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample02",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ },
+ {
+ "Widget": {
+ "$dtId": "Twin-01",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample01",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ "Gadget": {
+ "$dtId": "Twin-10",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample10",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryNextPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryNextPage.json
new file mode 100644
index 000000000000..324f59fb01ba
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/QueryNextPage.json
@@ -0,0 +1,73 @@
+{
+ "parameters": {
+ "querySpecification": {
+ "continuationToken": ""
+ },
+ "api-version": "2023-02-27-preview"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "$dtId": "Twin-04",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample04",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-05",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample05",
+ "temp": 79,
+ "comfortIndex": 50
+ },
+ {
+ "$dtId": "Twin-06",
+ "$metadata": {
+ "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
+ "$model": "dtmi:com:example:Sample;1",
+ "name": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "temp": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ },
+ "comfortIndex": {
+ "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
+ }
+ },
+ "name": "Sample06",
+ "temp": 79,
+ "comfortIndex": 50
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetry.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetry.json
new file mode 100644
index 000000000000..bd2a35057adb
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetry.json
@@ -0,0 +1,14 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "Message-Id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5",
+ "Telemetry-Source-Time": "1985-04-12T23:20:50.52Z",
+ "telemetry": {
+ "temperature": 1
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetryFromComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetryFromComponent.json
new file mode 100644
index 000000000000..b1b064914ca8
--- /dev/null
+++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/SendTelemetryFromComponent.json
@@ -0,0 +1,15 @@
+{
+ "parameters": {
+ "api-version": "2023-02-27-preview",
+ "id": "myTwinId",
+ "componentPath": "myComponent",
+ "Message-Id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5",
+ "Telemetry-Source-Time": "1985-04-12T23:20:50.52Z",
+ "telemetry": {
+ "temperature": 1
+ }
+ },
+ "responses": {
+ "204": {}
+ }
+}
diff --git a/specification/digitaltwins/data-plane/readme.md b/specification/digitaltwins/data-plane/readme.md
index 234e232f0a99..a840a9a9e68a 100644
--- a/specification/digitaltwins/data-plane/readme.md
+++ b/specification/digitaltwins/data-plane/readme.md
@@ -26,15 +26,23 @@ These are the global settings for Azure Digital Twins.
``` yaml
openapi-type: data-plane
-tag: package-2022-05-31
+tag: package-preview-2023-02-27
```
+### Tag: package-preview-2023-02-27
+
+These settings apply only when `--tag=package-preview-2023-02-27` is specified on the command line.
+
+``` yaml $(tag) == 'package-preview-2023-02-27'
+input-file:
+ - Microsoft.DigitalTwins/preview/2023-02-27-preview/digitaltwins.json
+```
### Tag: package-2022-05-31
These settings apply only when `--tag=package-2022-05-31` is specified on the command line.
-```yaml $(tag) == 'package-2022-05-31'
+``` yaml $(tag) == 'package-2022-05-31'
input-file:
- Microsoft.DigitalTwins/stable/2022-05-31/digitaltwins.json
```
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/domainservices.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/domainservices.json
new file mode 100644
index 000000000000..e565c611427d
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/domainservices.json
@@ -0,0 +1,1175 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Domain Services Resource Provider",
+ "description": "The AAD Domain Services API.",
+ "version": "2022-12-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": {
+ "/providers/Microsoft.AAD/operations": {
+ "get": {
+ "tags": [
+ "DomainServices"
+ ],
+ "description": "Lists all the available Domain Services operations.",
+ "operationId": "DomainServiceOperations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OperationEntityListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Operations": {
+ "$ref": "./examples/GetOperations.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.AAD/domainServices": {
+ "get": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_List",
+ "summary": "List Domain Services in Subscription",
+ "description": "The List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/DomainServiceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Domain Service": {
+ "$ref": "./examples/ListDomainServicesBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices": {
+ "get": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_ListByResourceGroup",
+ "summary": "List Domain Services in Resource Group",
+ "description": "The List Domain Services in Resource Group operation lists all the domain services available under the given resource group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/DomainServiceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Domain Service": {
+ "$ref": "./examples/ListDomainServicesByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AAD/domainServices/{domainServiceName}": {
+ "put": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_CreateOrUpdate",
+ "summary": "Create or Update Domain Service (PUT Resource)",
+ "description": "The Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "name": "domainService",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ },
+ "description": "Properties supplied to the Create or Update a Domain Service operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "201": {
+ "description": "HTTP 201 (Created) if the operation completed successfully.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create Domain Service": {
+ "$ref": "./examples/CreateDomainService.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_Get",
+ "summary": "Get Domain Service",
+ "description": "The Get Domain Service operation retrieves a json representation of the Domain Service.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Domain Service": {
+ "$ref": "./examples/GetDomainService.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_Delete",
+ "summary": "Delete Domain Service (DELETE Resource)",
+ "description": "The Delete Domain Service operation deletes an existing Domain Service.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously."
+ },
+ "204": {
+ "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete Domain Service": {
+ "$ref": "./examples/DeleteDomainService.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "DomainServices"
+ ],
+ "operationId": "DomainServices_Update",
+ "summary": "Update Domain Service (PATCH Resource)",
+ "description": "The Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "name": "domainService",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ },
+ "description": "Properties supplied to the Update a Domain Service operation."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/DomainService"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update Domain Service": {
+ "$ref": "./examples/UpdateDomainService.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Resource": {
+ "description": "The Resource model definition.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource Id"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Resource etag"
+ },
+ "systemData": {
+ "readOnly": true,
+ "description": "The system meta data relating to this resource.",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "DomainService": {
+ "description": "Domain service.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/DomainServiceProperties",
+ "description": "Domain service properties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "DomainServiceListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DomainService"
+ },
+ "description": "the list of domain services."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token for the next page of results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List Domain Services operation."
+ },
+ "DomainServiceProperties": {
+ "description": "Properties of the Domain Service.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "readOnly": true,
+ "type": "integer",
+ "format": "int32",
+ "description": "Data Model Version"
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Azure Active Directory Tenant Id"
+ },
+ "domainName": {
+ "type": "string",
+ "description": "The name of the Azure domain that the user would like to deploy Domain Services to."
+ },
+ "deploymentId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment Id"
+ },
+ "syncOwner": {
+ "readOnly": true,
+ "type": "string",
+ "description": "SyncOwner ReplicaSet Id"
+ },
+ "syncApplicationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The unique sync application id of the Azure AD Domain Services deployment."
+ },
+ "replicaSets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ReplicaSet",
+ "description": "ReplicaSet"
+ },
+ "description": "List of ReplicaSets"
+ },
+ "ldapsSettings": {
+ "$ref": "#/definitions/LdapsSettings",
+ "description": "Secure LDAP Settings"
+ },
+ "resourceForestSettings": {
+ "$ref": "#/definitions/ResourceForestSettings",
+ "description": "Resource Forest Settings"
+ },
+ "domainSecuritySettings": {
+ "$ref": "#/definitions/DomainSecuritySettings",
+ "description": "DomainSecurity Settings"
+ },
+ "domainConfigurationType": {
+ "type": "string",
+ "description": "Domain Configuration Type"
+ },
+ "sku": {
+ "type": "string",
+ "description": "Sku Type"
+ },
+ "filteredSync": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "description": "Enabled or Disabled flag to turn on Group-based filtered sync",
+ "x-ms-enum": {
+ "name": "FilteredSync",
+ "modelAsString": true
+ }
+ },
+ "syncScope": {
+ "type": "string",
+ "enum": [
+ "All",
+ "CloudOnly"
+ ],
+ "description": "All or CloudOnly, All users in AAD are synced to AAD DS domain or only users actively syncing in the cloud",
+ "x-ms-enum": {
+ "name": "SyncScope",
+ "modelAsString": true
+ }
+ },
+ "notificationSettings": {
+ "$ref": "#/definitions/NotificationSettings",
+ "description": "Notification Settings"
+ },
+ "migrationProperties": {
+ "readOnly": true,
+ "$ref": "#/definitions/MigrationProperties",
+ "description": "Migration Properties"
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "the current deployment or provisioning state, which only appears in the response."
+ },
+ "configDiagnostics": {
+ "$ref": "#/definitions/ConfigDiagnostics",
+ "description": "Configuration diagnostics data containing latest execution from client."
+ }
+ }
+ },
+ "ReplicaSet": {
+ "description": "Replica Set Definition",
+ "type": "object",
+ "properties": {
+ "replicaSetId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "ReplicaSet Id"
+ },
+ "location": {
+ "type": "string",
+ "description": "Virtual network location"
+ },
+ "vnetSiteId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Virtual network site id"
+ },
+ "subnetId": {
+ "type": "string",
+ "description": "The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName."
+ },
+ "domainControllerIpAddress": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Domain Controller IP Address"
+ },
+ "description": "List of Domain Controller IP Address"
+ },
+ "externalAccessIpAddress": {
+ "readOnly": true,
+ "type": "string",
+ "description": "External access ip address."
+ },
+ "serviceStatus": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Status of Domain Service instance"
+ },
+ "healthLastEvaluated": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last domain evaluation run DateTime"
+ },
+ "healthMonitors": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HealthMonitor",
+ "description": "Domain Health Monitors"
+ },
+ "description": "List of Domain Health Monitors"
+ },
+ "healthAlerts": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HealthAlert",
+ "description": "Domain Health Alerts"
+ },
+ "description": "List of Domain Health Alerts"
+ }
+ }
+ },
+ "LdapsSettings": {
+ "description": "Secure LDAP Settings",
+ "type": "object",
+ "properties": {
+ "ldaps": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Disabled",
+ "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "Ldaps",
+ "modelAsString": true
+ }
+ },
+ "pfxCertificate": {
+ "type": "string",
+ "description": "The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file."
+ },
+ "pfxCertificatePassword": {
+ "type": "string",
+ "description": "The password to decrypt the provided Secure LDAP certificate pfx file."
+ },
+ "publicCertificate": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Public certificate used to configure secure ldap."
+ },
+ "certificateThumbprint": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Thumbprint of configure ldaps certificate."
+ },
+ "certificateNotAfter": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "NotAfter DateTime of configure ldaps certificate."
+ },
+ "externalAccess": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Disabled",
+ "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "ExternalAccess",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "HealthMonitor": {
+ "description": "Health Monitor Description",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Monitor Id"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Monitor Name"
+ },
+ "details": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Monitor Details"
+ }
+ }
+ },
+ "HealthAlert": {
+ "description": "Health Alert Description",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Alert Id"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Alert Name"
+ },
+ "issue": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Alert Issue"
+ },
+ "severity": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Alert Severity"
+ },
+ "raised": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Health Alert Raised DateTime"
+ },
+ "lastDetected": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "Health Alert Last Detected DateTime"
+ },
+ "resolutionUri": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Health Alert TSG Link"
+ }
+ }
+ },
+ "NotificationSettings": {
+ "description": "Settings for notification",
+ "type": "object",
+ "properties": {
+ "notifyGlobalAdmins": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "description": "Should global admins be notified",
+ "x-ms-enum": {
+ "name": "notifyGlobalAdmins",
+ "modelAsString": true
+ }
+ },
+ "notifyDcAdmins": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "description": "Should domain controller admins be notified",
+ "x-ms-enum": {
+ "name": "notifyDcAdmins",
+ "modelAsString": true
+ }
+ },
+ "additionalRecipients": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Email address for additional recipient"
+ },
+ "description": "The list of additional recipients"
+ }
+ }
+ },
+ "ResourceForestSettings": {
+ "description": "Settings for Resource Forest",
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ForestTrust"
+ },
+ "description": "List of settings for Resource Forest"
+ },
+ "resourceForest": {
+ "type": "string",
+ "description": "Resource Forest"
+ }
+ }
+ },
+ "ForestTrust": {
+ "description": "Forest Trust Setting",
+ "type": "object",
+ "properties": {
+ "trustedDomainFqdn": {
+ "type": "string",
+ "description": "Trusted Domain FQDN"
+ },
+ "trustDirection": {
+ "type": "string",
+ "description": "Trust Direction"
+ },
+ "friendlyName": {
+ "type": "string",
+ "description": "Friendly Name"
+ },
+ "remoteDnsIps": {
+ "type": "string",
+ "description": "Remote Dns ips"
+ },
+ "trustPassword": {
+ "type": "string",
+ "description": "Trust Password",
+ "x-ms-secret": true
+ }
+ }
+ },
+ "MigrationProperties": {
+ "description": "Migration Properties",
+ "type": "object",
+ "properties": {
+ "oldSubnetId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Old Subnet Id"
+ },
+ "oldVnetSiteId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Old Vnet Site Id"
+ },
+ "migrationProgress": {
+ "readOnly": true,
+ "$ref": "#/definitions/MigrationProgress",
+ "description": "Migration Progress"
+ }
+ }
+ },
+ "MigrationProgress": {
+ "description": "Migration Progress",
+ "type": "object",
+ "properties": {
+ "completionPercentage": {
+ "type": "number",
+ "format": "double",
+ "description": "Completion Percentage"
+ },
+ "progressMessage": {
+ "type": "string",
+ "description": "Progress Message"
+ }
+ }
+ },
+ "DomainSecuritySettings": {
+ "description": "Domain Security Settings",
+ "type": "object",
+ "properties": {
+ "ntlmV1": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "NtlmV1",
+ "modelAsString": true
+ }
+ },
+ "tlsV1": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not TlsV1 is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "TlsV1",
+ "modelAsString": true
+ }
+ },
+ "syncNtlmPasswords": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "SyncNtlmPasswords",
+ "modelAsString": true
+ }
+ },
+ "syncKerberosPasswords": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "SyncKerberosPasswords",
+ "modelAsString": true
+ }
+ },
+ "syncOnPremPasswords": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "SyncOnPremPasswords",
+ "modelAsString": true
+ }
+ },
+ "kerberosRc4Encryption": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Enabled",
+ "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "KerberosRc4Encryption",
+ "modelAsString": true
+ }
+ },
+ "kerberosArmoring": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Disabled",
+ "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "KerberosArmoring",
+ "modelAsString": true
+ }
+ },
+ "ldapSigning": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Disabled",
+ "description": "A flag to determine whether or not LdapSigning is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "LdapSigning",
+ "modelAsString": true
+ }
+ },
+ "channelBinding": {
+ "type": "string",
+ "enum": [
+ "Enabled",
+ "Disabled"
+ ],
+ "default": "Disabled",
+ "description": "A flag to determine whether or not ChannelBinding is enabled or disabled.",
+ "x-ms-enum": {
+ "name": "ChannelBinding",
+ "modelAsString": true
+ }
+ }
+ }
+ },
+ "ConfigDiagnostics": {
+ "description": "Configuration Diagnostics",
+ "type": "object",
+ "properties": {
+ "lastExecuted": {
+ "type": "string",
+ "format": "date-time-rfc1123",
+ "description": "Last domain configuration diagnostics DateTime"
+ },
+ "validatorResults": {
+ "type": "array",
+ "description": "List of Configuration Diagnostics validator results.",
+ "items": {
+ "$ref": "#/definitions/ConfigDiagnosticsValidatorResult"
+ }
+ }
+ }
+ },
+ "ConfigDiagnosticsValidatorResult": {
+ "description": "Config Diagnostics validator result data",
+ "type": "object",
+ "properties": {
+ "validatorId": {
+ "type": "string",
+ "description": "Validator identifier"
+ },
+ "replicaSetSubnetDisplayName": {
+ "type": "string",
+ "description": "Replica set location and subnet name"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "None",
+ "Running",
+ "OK",
+ "Failure",
+ "Warning",
+ "Skipped"
+ ],
+ "default": "None",
+ "description": "Status for individual validator after running diagnostics.",
+ "x-ms-enum": {
+ "name": "status",
+ "modelAsString": true
+ }
+ },
+ "issues": {
+ "type": "array",
+ "description": "List of resource config validation issues.",
+ "items": {
+ "$ref": "#/definitions/ConfigDiagnosticsValidatorResultIssue"
+ }
+ }
+ }
+ },
+ "ConfigDiagnosticsValidatorResultIssue": {
+ "description": "Specific issue for a particular config diagnostics validator",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Validation issue identifier."
+ },
+ "descriptionParams": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Single resource property involved in issue description."
+ },
+ "description": "List of domain resource property name or values used to compose a rich description."
+ }
+ }
+ },
+ "CloudError": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "description": "An error response from the Domain Services.",
+ "$ref": "#/definitions/CloudErrorBody"
+ }
+ },
+ "description": "An error response from the Domain Services."
+ },
+ "CloudErrorBody": {
+ "type": "object",
+ "x-ms-external": true,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ },
+ "target": {
+ "type": "string",
+ "description": "The target of the particular error. For example, the name of the property in error."
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CloudErrorBody"
+ },
+ "description": "A list of additional details about the error."
+ }
+ },
+ "description": "An error response from the Domain Services."
+ },
+ "OperationEntityListResult": {
+ "description": "The list of domain service operation response.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationEntity"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token for the next page of results.",
+ "readOnly": true
+ }
+ }
+ },
+ "OperationEntity": {
+ "description": "The operation supported by Domain Services.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayInfo",
+ "description": "The operation supported by Domain Services."
+ },
+ "origin": {
+ "description": "The origin of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDisplayInfo": {
+ "description": "The operation supported by Domain Services.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of the operation.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The action that users can perform, based on their permission level.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Service provider: Domain Services.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Client Api Version."
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group within the user's subscription. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "DomainServiceNameParameter": {
+ "name": "domainServiceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the domain service.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateDomainService.json
new file mode 100644
index 000000000000..528d21d67d9a
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateDomainService.json
@@ -0,0 +1,181 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "TestResourceGroup",
+ "domainServiceName": "TestDomainService.com",
+ "domainService": {
+ "properties": {
+ "domainName": "TestDomainService.com",
+ "replicaSets": [
+ {
+ "location": "West US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "pfxCertificatePassword": "",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "description": "HTTP 201 (Created) if the operation completed successfully.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "replicaSets": [
+ {
+ "location": "West US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Accepted"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateOuContainer.json
new file mode 100644
index 000000000000..2ffc1a7002b7
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/CreateOuContainer.json
@@ -0,0 +1,94 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "OuContainerResourceGroup",
+ "domainServiceName": "OuContainer.com",
+ "ouContainerName": "OuContainer1",
+ "containerAccount": {
+ "accountName": "AccountName1",
+ "spn": "Spn1",
+ "password": ""
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "201": {
+ "description": "HTTP 201 (Created) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteDomainService.json
new file mode 100644
index 000000000000..4b4557b10d8c
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteDomainService.json
@@ -0,0 +1,22 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "TestResourceGroup",
+ "domainServiceName": "TestDomainService.com"
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously."
+ },
+ "204": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed."
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteOuContainer.json
new file mode 100644
index 000000000000..884f5f361eed
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/DeleteOuContainer.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "OuContainerResourceGroup",
+ "domainServiceName": "OuContainer.com",
+ "ouContainerName": "OuContainer1"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful."
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously."
+ },
+ "204": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed."
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetDomainService.json
new file mode 100644
index 000000000000..1d1874324b68
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetDomainService.json
@@ -0,0 +1,85 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "TestResourceGroup",
+ "domainServiceName": "TestDomainService.com"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running",
+ "healthLastEvaluated": "15 Feb 2018 21:43:21 GMT",
+ "healthMonitors": [
+ {
+ "id": "AADDS501",
+ "name": "Backup",
+ "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT"
+ },
+ {
+ "id": "AADDS500",
+ "name": "Synchronization with Azure AD",
+ "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT."
+ }
+ ],
+ "healthAlerts": [
+ {
+ "id": "AADDS104",
+ "name": "The managed domain is experiencing a network error",
+ "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.",
+ "severity": "2",
+ "raised": "2018-09-18T01:55:40.7834289Z",
+ "lastDetected": "2018-09-18T17:46:39.2697888Z",
+ "resolutionUri": "https://aka.ms/aadds-neterr"
+ }
+ ]
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOperations.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOperations.json
new file mode 100644
index 000000000000..54c1c2e24c60
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOperations.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.AAD/unregister/action",
+ "display": {
+ "provider": "Domain Services Resource Provider",
+ "resource": "Domain Service Type",
+ "operation": "Unregister Domain Service",
+ "description": "Unregisters Domain Services"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.AAD/register/action",
+ "display": {
+ "provider": "Domain Services Resource Provider",
+ "resource": "Domain Service Type",
+ "operation": "Register Domain Service",
+ "description": "Registers Domain Services"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.AAD/domainServices/read",
+ "display": {
+ "provider": "Domain Services Resource Provider",
+ "resource": "Domain Service Type",
+ "operation": "Read Domain Service",
+ "description": "Reads Domain Services"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.AAD/domainServices/write",
+ "display": {
+ "provider": "Domain Services Resource Provider",
+ "resource": "Domain Service Type",
+ "operation": "Write Domain Service",
+ "description": "Writes Domain Services"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.AAD/domainServices/delete",
+ "display": {
+ "provider": "Domain Services Resource Provider",
+ "resource": "Domain Service Type",
+ "operation": "Delete Domain Service",
+ "description": "Deletes Domain Services"
+ },
+ "origin": "user,system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOuContainer.json
new file mode 100644
index 000000000000..0c4498afbef1
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/GetOuContainer.json
@@ -0,0 +1,37 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "OuContainerResourceGroup",
+ "domainServiceName": "OuContainer.com",
+ "ouContainerName": "OuContainer1"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesByResourceGroup.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesByResourceGroup.json
new file mode 100644
index 000000000000..fb8887e9a0eb
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesByResourceGroup.json
@@ -0,0 +1,88 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "TestResourceGroup"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running",
+ "healthLastEvaluated": "15 Feb 2018 21:43:04 GMT",
+ "healthMonitors": [
+ {
+ "id": "AADDS501",
+ "name": "Backup",
+ "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT"
+ },
+ {
+ "id": "AADDS500",
+ "name": "Synchronization with Azure AD",
+ "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT."
+ }
+ ],
+ "healthAlerts": [
+ {
+ "id": "AADDS104",
+ "name": "The managed domain is experiencing a network error",
+ "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.",
+ "severity": "2",
+ "raised": "2018-09-18T01:55:40.7834289Z",
+ "lastDetected": "2018-09-18T17:46:39.2697888Z",
+ "resolutionUri": "https://aka.ms/aadds-neterr"
+ }
+ ]
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesBySubscription.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesBySubscription.json
new file mode 100644
index 000000000000..10e6d9ffb330
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListDomainServicesBySubscription.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running",
+ "healthLastEvaluated": "15 Feb 2018 21:37:04 GMT",
+ "healthMonitors": [
+ {
+ "id": "AADDS501",
+ "name": "Backup",
+ "details": "Last backed up on Tue, 18 Sep 2018 03:37:04 GMT"
+ },
+ {
+ "id": "AADDS500",
+ "name": "Synchronization with Azure AD",
+ "details": "Synchronized on Tue, 18 Sep 2018 16:47:57 GMT."
+ }
+ ],
+ "healthAlerts": [
+ {
+ "id": "AADDS104",
+ "name": "The managed domain is experiencing a network error",
+ "issue": "Microsoft is unable to reach the domain controllers for this managed domain. This may happen if a network security group (NSG) configured on your virtual network blocks access to the managed domain. Another possible reason is if there is a user defined route that blocks incoming traffic from the internet.",
+ "severity": "2",
+ "raised": "2018-09-18T01:55:40.7834289Z",
+ "lastDetected": "2018-09-18T17:46:39.2697888Z",
+ "resolutionUri": "https://aka.ms/aadds-neterr"
+ }
+ ]
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListOuContainers.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListOuContainers.json
new file mode 100644
index 000000000000..693749d470f2
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/ListOuContainers.json
@@ -0,0 +1,63 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "OuContainerResourceGroup",
+ "domainServiceName": "OuContainer.com"
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ },
+ {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer2",
+ "name": "OuContainer.com/OuContainer2",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer2",
+ "accounts": [
+ {
+ "accountName": "AccountName3",
+ "spn": "Spn3"
+ },
+ {
+ "accountName": "AccountName4",
+ "spn": "Spn4"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateDomainService.json
new file mode 100644
index 000000000000..6d6760a5fc06
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateDomainService.json
@@ -0,0 +1,179 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "TestResourceGroup",
+ "domainServiceName": "TestDomainService.com",
+ "domainService": {
+ "properties": {
+ "replicaSets": [
+ {
+ "location": "West US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS"
+ },
+ {
+ "location": "East US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "pfxCertificatePassword": "",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "configDiagnostics": {
+ "lastExecuted": "05 May 2021 12:00:23 GMT",
+ "validatorResults": [
+ {
+ "validatorId": "AADDS-CFG-DIAG-V06",
+ "replicaSetSubnetDisplayName": "West US/aadds-subnet",
+ "status": "Warning",
+ "issues": [
+ {
+ "id": "AADDS-CFG-DIAG-I20",
+ "descriptionParams": []
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "externalAccessIpAddress": "13.64.148.151",
+ "serviceStatus": "Running"
+ },
+ {
+ "replicaSetId": "5057347d-cad1-4ec8-8db6-66cf7eedf4b8",
+ "location": "East US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS",
+ "domainControllerIpAddress": [
+ "10.0.0.3",
+ "10.0.0.4"
+ ],
+ "externalAccessIpAddress": "13.64.148.152",
+ "serviceStatus": "Running"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/DomainServices/TestDomainService.com",
+ "name": "TestDomainService.com",
+ "type": "Microsoft.AAD/DomainServices",
+ "properties": {
+ "version": 2,
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "TestDomainService.com",
+ "deploymentId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "syncOwner": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "replicaSets": [
+ {
+ "replicaSetId": "4a619871-0150-41c4-aeb4-0b10deb7940a",
+ "location": "West US",
+ "vnetSiteId": "99083198-a39c-469f-972d-59017e7f078c",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetWUS/subnets/TestSubnetWUS",
+ "domainControllerIpAddress": [
+ "10.0.0.1",
+ "10.0.0.2"
+ ],
+ "serviceStatus": "Running"
+ },
+ {
+ "location": "East US",
+ "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/TestVnetEUS/subnets/TestSubnetEUS"
+ }
+ ],
+ "ldapsSettings": {
+ "ldaps": "Enabled",
+ "publicCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...",
+ "certificateThumbprint": "9154A390F0C387D679E0DD040701745CDFED67F3",
+ "certificateNotAfter": "2018-02-15T21:43:21Z",
+ "externalAccess": "Enabled"
+ },
+ "domainSecuritySettings": {
+ "ntlmV1": "Enabled",
+ "tlsV1": "Disabled",
+ "syncNtlmPasswords": "Enabled"
+ },
+ "filteredSync": "Enabled",
+ "notificationSettings": {
+ "notifyGlobalAdmins": "Enabled",
+ "notifyDcAdmins": "Enabled",
+ "additionalRecipients": [
+ "jicha@microsoft.com",
+ "caalmont@microsoft.com"
+ ]
+ },
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateOuContainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateOuContainer.json
new file mode 100644
index 000000000000..1f4813a38dcb
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/examples/UpdateOuContainer.json
@@ -0,0 +1,71 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d",
+ "resourceGroupName": "OuContainerResourceGroup",
+ "domainServiceName": "OuContainer.com",
+ "ouContainerName": "OuContainer1",
+ "containerAccount": {
+ "accountName": "AccountName1",
+ "spn": "Spn1",
+ "password": ""
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "https://management.azure.com/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/TestResourceGroup/providers/Microsoft.AAD/domainServices/TestDomainService.com?api-version=2022-09-01"
+ },
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "body": {
+ "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/ouContainerResourceGroup/providers/Microsoft.AAD/domainServices/ouContainer.com/ouContainer/ouContainer1",
+ "name": "OuContainer.com/OuContainer1",
+ "type": "Microsoft.AAD/DomainServices/OuContainer",
+ "properties": {
+ "tenantId": "3f8cd22c-7b32-48aa-a01c-f533133b1def",
+ "domainName": "OuContainer.com",
+ "deploymentId": "0FC50BDB-AC45-48E4-BC92-F0651EA0687B",
+ "containerId": "OuContainer1",
+ "accounts": [
+ {
+ "accountName": "AccountName1",
+ "spn": "Spn1"
+ },
+ {
+ "accountName": "AccountName2",
+ "spn": "Spn2"
+ }
+ ],
+ "serviceStatus": "Running",
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/oucontainer.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/oucontainer.json
new file mode 100644
index 000000000000..9318df42661a
--- /dev/null
+++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2022-12-01/oucontainer.json
@@ -0,0 +1,583 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Domain Services Resource Provider",
+ "description": "The AAD Domain Services API.",
+ "version": "2022-12-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": {
+ "/providers/Microsoft.Aad/operations": {
+ "get": {
+ "tags": [
+ "OuContainer"
+ ],
+ "description": "Lists all the available OuContainer operations.",
+ "operationId": "OuContainerOperations_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OperationEntityListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Operations": {
+ "$ref": "./examples/GetOperations.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer": {
+ "get": {
+ "tags": [
+ "OuContainer"
+ ],
+ "operationId": "OuContainer_List",
+ "summary": "List of OuContainers in DomainService instance",
+ "description": "The List of OuContainers in DomainService instance.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OuContainerListResult"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List of OuContainers": {
+ "$ref": "./examples/ListOuContainers.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Aad/domainServices/{domainServiceName}/ouContainer/{ouContainerName}": {
+ "get": {
+ "tags": [
+ "OuContainer"
+ ],
+ "operationId": "OuContainer_Get",
+ "summary": "Get particular OuContainer in DomainService instance",
+ "description": "Get OuContainer in DomainService instance.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OuContainerNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List of OuContainers": {
+ "$ref": "./examples/GetOuContainer.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "OuContainer"
+ ],
+ "operationId": "OuContainer_Create",
+ "summary": "Create OuContainer",
+ "description": "The Create OuContainer operation creates a new OuContainer under the specified Domain Service instance.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OuContainerNameParameter"
+ },
+ {
+ "name": "containerAccount",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ContainerAccount"
+ },
+ "description": "Container Account Description."
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ },
+ "201": {
+ "description": "HTTP 201 (Created) if the operation completed successfully.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create Domain Service": {
+ "$ref": "./examples/CreateOuContainer.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "OuContainer"
+ ],
+ "operationId": "OuContainer_Delete",
+ "summary": "Delete OuContainer",
+ "description": "The Delete OuContainer operation deletes specified OuContainer.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OuContainerNameParameter"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful."
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously."
+ },
+ "204": {
+ "description": "HTTP 204 (Not Content) should be used if the resource does not exist and the request is well formed."
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Delete OuContainer": {
+ "$ref": "./examples/DeleteOuContainer.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "OuContainer"
+ ],
+ "operationId": "OuContainer_Update",
+ "summary": "Update OuContainer (PATCH Resource)",
+ "description": "The Update OuContainer operation can be used to update the existing OuContainers.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/DomainServiceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/OuContainerNameParameter"
+ },
+ {
+ "name": "containerAccount",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ContainerAccount"
+ },
+ "description": "Container Account Description."
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "./domainservices.json#/definitions/CloudError"
+ }
+ },
+ "200": {
+ "description": "HTTP 200 (OK) if the operation was successful.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ },
+ "202": {
+ "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.",
+ "schema": {
+ "$ref": "#/definitions/OuContainer"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Update Domain Service": {
+ "$ref": "./examples/UpdateOuContainer.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Resource": {
+ "description": "The Resource model definition.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource Id"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ },
+ "etag": {
+ "type": "string",
+ "description": "Resource etag"
+ },
+ "systemData": {
+ "readOnly": true,
+ "description": "The system meta data relating to this resource.",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "OuContainerListResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OuContainer"
+ },
+ "description": "The list of OuContainer."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token for the next page of results.",
+ "readOnly": true
+ }
+ },
+ "description": "The response from the List OuContainer operation."
+ },
+ "OuContainer": {
+ "description": "Resource for OuContainer.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/OuContainerProperties",
+ "description": "OuContainer properties"
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ]
+ },
+ "OuContainerProperties": {
+ "description": "Properties of the OuContainer.",
+ "type": "object",
+ "properties": {
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Azure Active Directory tenant id"
+ },
+ "domainName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The domain name of Domain Services."
+ },
+ "deploymentId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The Deployment id"
+ },
+ "containerId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The OuContainer name"
+ },
+ "accounts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContainerAccount",
+ "description": "Container Account"
+ },
+ "description": "The list of container accounts"
+ },
+ "serviceStatus": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Status of OuContainer instance"
+ },
+ "distinguishedName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Distinguished Name of OuContainer instance"
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The current deployment or provisioning state, which only appears in the response."
+ }
+ }
+ },
+ "ContainerAccount": {
+ "description": "Container Account Description",
+ "type": "object",
+ "properties": {
+ "accountName": {
+ "type": "string",
+ "description": "The account name"
+ },
+ "spn": {
+ "type": "string",
+ "description": "The account spn"
+ },
+ "password": {
+ "type": "string",
+ "description": "The account password"
+ }
+ }
+ },
+ "OperationEntityListResult": {
+ "description": "The list of domain service operation response.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The list of operations.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationEntity"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The continuation token for the next page of results.",
+ "readOnly": true
+ }
+ }
+ },
+ "OperationEntity": {
+ "description": "The operation supported by Domain Services.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}.",
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplayInfo",
+ "description": "The operation supported by Domain Services."
+ },
+ "origin": {
+ "description": "The origin of the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDisplayInfo": {
+ "description": "The operation supported by Domain Services.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of the operation.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "The action that users can perform, based on their permission level.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Service provider: Domain Services.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "Client Api Version."
+ },
+ "ResourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group within the user's subscription. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "DomainServiceNameParameter": {
+ "name": "domainServiceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the domain service.",
+ "x-ms-parameter-location": "method"
+ },
+ "OuContainerNameParameter": {
+ "name": "ouContainerName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the OuContainer.",
+ "x-ms-parameter-location": "method"
+ }
+ }
+}
diff --git a/specification/domainservices/resource-manager/readme.go.md b/specification/domainservices/resource-manager/readme.go.md
index bc42da0427d3..77b7fc76ab5f 100644
--- a/specification/domainservices/resource-manager/readme.go.md
+++ b/specification/domainservices/resource-manager/readme.go.md
@@ -21,6 +21,7 @@ azure-arm: true
``` yaml $(go) && $(multiapi)
batch:
+ - tag: package-2022-12
- tag: package-2022-09
- tag: package-2021-05
- tag: package-2020-01
@@ -28,6 +29,15 @@ batch:
- tag: package-2017-06
```
+### Tag: package-2022-12 and go
+
+These settings apply only when `--tag=package-2022-12 --go` is specified on the command line.
+Please also specify `--go-sdk-folder=`.
+
+``` yaml $(tag) == 'package-2022-12' && $(go)
+output-folder: $(go-sdk-folder)/services/domainservices/mgmt/2022-12-01/$(namespace)
+```
+
### Tag: package-2022-09 and go
These settings apply only when `--tag=package-2022-09 --go` is specified on the command line.
diff --git a/specification/domainservices/resource-manager/readme.md b/specification/domainservices/resource-manager/readme.md
index d33be5610979..3d9a5fbc0b66 100644
--- a/specification/domainservices/resource-manager/readme.md
+++ b/specification/domainservices/resource-manager/readme.md
@@ -26,8 +26,19 @@ These are the global settings for the DomainServices API.
``` yaml
openapi-type: arm
-tag: package-2022-09
+tag: package-2022-12
```
+
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+``` yaml $(tag) == 'package-2022-12'
+input-file:
+- Microsoft.AAD/stable/2022-12-01/domainservices.json
+- Microsoft.AAD/stable/2022-12-01/oucontainer.json
+```
+
### Tag: package-2022-09
These settings apply only when `--tag=package-2022-09` is specified on the command line.
@@ -142,6 +153,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-domainservices
``` yaml $(java) && $(multiapi)
batch:
+ - tag: package-2022-12
- tag: package-2022-09
- tag: package-2021-05
- tag: package-2021-03
@@ -150,6 +162,19 @@ batch:
- tag: package-2017-01
```
+### Tag: package-2022-12 and java
+
+These settings apply only when `--tag=package-2022-12 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=`.
+
+``` yaml $(tag) == 'package-2022-12' && $(java) && $(multiapi)
+java:
+ namespace: com.microsoft.azure.management.domainservices.v2022_12_01
+ output-folder: $(azure-libraries-for-java-folder)/sdk/domainservices/mgmt-v2022_12_01
+regenerate-manager: true
+generate-interface: true
+```
+
### Tag: package-2022-09 and java
These settings apply only when `--tag=package-2022-09 --java` is specified on the command line.
diff --git a/specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json b/specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json
index 29e07a5210e6..06ccf00f5105 100644
--- a/specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json
+++ b/specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json
@@ -15,6 +15,14 @@
"description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service///