From 25e3eaa8dd29c201625aebc33762ef9ab021eb9e Mon Sep 17 00:00:00 2001 From: tamilmani1989 Date: Sat, 26 Sep 2020 19:20:44 -0700 Subject: [PATCH] API Spec change for DNC RP (#10819) * updated apispec * spell error fix * removed dncappid from response * updated apispec * Added appid and endpoint in response * adde controller id in delegated subnet response * updated examples * updated * updated apispec * spell check and prettier fix * spell check fix * updated title same in all files * updated operationid * reverting to new change * addressed review comments * addressed feedback comments * spell check fix * updated readme.md * updated definition name * addressed feedback comments * fixed lint issue --- .../2020-08-08-preview/DelegatedNetwork.json | 1038 ----------------- .../2020-08-08-preview/controller.json | 506 ++++++++ .../2020-08-08-preview/delegatedSubnets.json | 520 +++++++++ ...rListByRG.json => controllerListByRG.json} | 8 +- ...istBySub.json => controllerListBySub.json} | 8 +- .../delegatedNetworkOperationsList.json | 27 + .../examples/delegatedSubnetListByRG.json | 12 +- .../examples/delegatedSubnetListBySub.json | 10 +- .../examples/deleteController.json | 2 +- .../examples/deleteDelegatedSubnet.json | 7 +- .../examples/deleteOrchestrator.json | 21 + .../examples/getController.json | 10 +- .../examples/getDelegatedSubnet.json | 14 +- .../examples/getOrchestrator.json | 36 + .../orchestratorInstanceListByRG.json | 39 + .../orchestratorInstanceListBySub.json | 38 + .../examples/patchController.json | 35 +- .../examples/patchDelegatedSubnet.json | 35 +- .../examples/patchOrchestrator.json | 44 + .../examples/putController.json | 26 +- .../examples/putDelegatedSubnet.json | 30 +- .../examples/putOrchestrator.json | 68 ++ .../2020-08-08-preview/operations.json | 194 +++ .../2020-08-08-preview/orchestrators.json | 567 +++++++++ specification/dnc/resource-manager/readme.md | 6 +- 25 files changed, 2168 insertions(+), 1133 deletions(-) delete mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json rename specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/{delegatedNetworkControllerListByRG.json => controllerListByRG.json} (73%) rename specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/{delegatedNetworkControllerListBySub.json => controllerListBySub.json} (72%) create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json deleted file mode 100644 index 8d03de36a68f..000000000000 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json +++ /dev/null @@ -1,1038 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-08-08-preview", - "title": "DNC", - "description": "DNC web api provides way to create, get and delete dnc controller" - }, - "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.DelegatedNetwork/controller/{resourceName}": { - "get": { - "description": "Gets details about the specified dnc controller.", - "x-ms-examples": { - "Get details of a controller": { - "$ref": "./examples/getController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_GetDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Create a dnc controller", - "x-ms-examples": { - "Create controller": { - "$ref": "./examples/putController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Create", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "controllerParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ControllerTypeParameters" - }, - "description": "controller type parameters" - } - ], - "responses": { - "200": { - "description": "OK. The operation completed successfully.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "201": { - "description": "InProgress. The operation is still in progress.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes the DNC controller", - "x-ms-examples": { - "Delete controller": { - "$ref": "./examples/deleteController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "description": "Update dnc controller", - "x-ms-examples": { - "update controller": { - "$ref": "./examples/patchController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Patch", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "controllerParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ControllerTypeParameters" - }, - "description": "controller type parameters" - } - ], - "responses": { - "200": { - "description": "OK. The operation completed successfully.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "201": { - "description": "InProgress. The operation is still in progress.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}": { - "get": { - "description": "Gets details about the specified dnc DelegatedSubnet Link.", - "x-ms-examples": { - "Get details of a delegated subnet": { - "$ref": "./examples/getDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_GetDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Put delegated subnet resource", - "x-ms-examples": { - "put delegated subnet": { - "$ref": "./examples/putDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_PutDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "delegatedSubnetParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DelegatedSubnetParameters" - }, - "description": "Delegated subnet details." - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "201": { - "description": "InProgress. The operation is still in progress", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "description": "Patch delegated subnet resource", - "x-ms-examples": { - "patch delegated subnet": { - "$ref": "./examples/patchDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_PatchDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "delegatedSubnetParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DelegatedSubnetParameters" - }, - "description": "Delegated subnet details." - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "201": { - "description": "InProgress. The operation is still in progress", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Delete dnc DelegatedSubnet.", - "x-ms-examples": { - "delete delegated subnet": { - "$ref": "./examples/deleteDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_DeleteDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedControllers": { - "get": { - "tags": [ - "DelegatedControllers" - ], - "description": "Get all the delegatedController resources in a subscription.", - "operationId": "DelegatedNetwork_ListBySubscription", - "x-ms-examples": { - "Get DelegatedController resources by subscription": { - "$ref": "./examples/delegatedNetworkControllerListBySub.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedControllers in the subscription.", - "schema": { - "$ref": "#/definitions/DelegatedControllers" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedControllers": { - "get": { - "tags": [ - "DelegatedControllers" - ], - "description": "Get all the delegatedController resources in a resource group.", - "operationId": "DelegatedNetwork_ListByResourceGroup", - "x-ms-examples": { - "Get DelegatedNetwork resources by resource group": { - "$ref": "./examples/delegatedNetworkControllerListByRG.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the delegatedControllers in the resource group.", - "schema": { - "$ref": "#/definitions/DelegatedControllers" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedSubnetInstances": { - "get": { - "tags": [ - "DelegatedSubnets" - ], - "description": "Get all the DelegatedSubnets resources in a subscription.", - "operationId": "DelegatedSubnetService_ListBySubscription", - "x-ms-examples": { - "Get DelegatedSubnets resources by subscription": { - "$ref": "./examples/delegatedSubnetListBySub.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the subscription.", - "schema": { - "$ref": "#/definitions/DelegatedSubnetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnetInstances": { - "get": { - "tags": [ - "DelegatedSubnets" - ], - "description": "Get all the DelegatedSubnets resources in a resource group.", - "operationId": "DelegatedSubnetService_ListByResourceGroup", - "x-ms-examples": { - "Get DelegatedSubnets resources by resource group": { - "$ref": "./examples/delegatedSubnetListByRG.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the resource group.", - "schema": { - "$ref": "#/definitions/DelegatedSubnetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.DelegatedNetwork/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available DelegatedNetwork service REST API operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get available operations": { - "$ref": "./examples/delegatedNetworkOperationsList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of request to list controller operations.It contains a list of operations and a URL link to get the next set of results", - "type": "object", - "properties": { - "value": { - "type": "array", - "uniqueItems": false, - "readOnly": true, - "description": "List of operations supported by the Microsoft.DelegatedNetwork resource provider.", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string" - } - } - }, - "Operation": { - "description": "Microsoft.DelegatedNetwork REST API operation definition", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string", - "readOnly": true - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Gets or sets a value indicating whether the operation is a data action or not.", - "type": "boolean" - }, - "display": { - "description": "Operation properties display", - "$ref": "#/definitions/OperationDisplay" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation" - } - } - }, - "OperationDisplay": { - "description": "The object that represents the operation.", - "type": "object", - "properties": { - "provider": { - "description": "Service provider: Microsoft.DelegatedNetwork.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource on which the operation is performed: controller, etc.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Operation type: create, get, delete, etc.", - "type": "string", - "readOnly": true - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Friendly description for the operation," - } - } - }, - "OperationProperties": { - "description": "Operation properties.", - "type": "object", - "properties": {} - }, - "ControllerResource": { - "description": "Represents an instance of an DNC controller resource.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "An identifier that represents the DNC controller resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the DNC controller resource." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of the DNC controller resource.(Microsoft.DelegatedNetwork/controller)" - }, - "location": { - "type": "string", - "description": "Location of the DNC controller resource." - } - }, - "x-ms-azure-resource": true - }, - "DelegatedControllers": { - "description": "An array of Delegated controller resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DelegatedController" - }, - "description": "An array of Delegated controller resources." - } - }, - "required": [ - "value" - ] - }, - "ControllerTypeParameters": { - "description": "Details of controller type.", - "type": "object", - "properties": { - "controllerType": { - "type": "string", - "description": "Type of controller", - "enum": [ - "Kubernetes" - ], - "x-ms-enum": { - "name": "ControllerType", - "modelAsString": true - } - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Controller properties", - "$ref": "#/definitions/ControllerInstanceProperties" - } - } - }, - "DelegatedController": { - "description": "Represents an instance of a DNC controller.", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ControllerResponseProperties", - "description": "Properties of the provision operation request." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ControllerResource" - } - ] - }, - "ControllerResponseProperties": { - "description": "Properties of Delegated controller resource.", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "Deleting", - "Succeeded", - "Failed", - "Provisioning" - ], - "x-ms-enum": { - "name": "ControllerState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current state of dnc controller resource." - }, - "dncAppId": { - "type": "string", - "description": "The current state of dnc controller resource." - }, - "dncEndpoint": { - "type": "string", - "description": "dnc endpoint url that customers can use to connect to" - } - } - }, - "ControllerInstanceProperties": { - "description": "Properties of orchestrator", - "type": "object", - "properties": { - "serverAppID": { - "description": "AAD ID used with apiserver", - "type": "string" - }, - "serverTenantID": { - "description": "TenantID of server App ID", - "type": "string" - }, - "clusterRootCA": { - "description": "RootCA certificate of kubernetes cluster", - "type": "string" - }, - "apiServerEndpoint": { - "description": "APIServer url", - "type": "string" - } - } - }, - "DelegatedSubnetResource": { - "description": "Represents an instance of a DelegatedSubnet resource.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "An identifier that represents the DelegatedSubnet resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the DelegatedSubnet resource." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of the DelegatedSubnet resource.(Microsoft.DelegatedNetwork/delegatedSubnet)" - }, - "location": { - "type": "string", - "description": "Location of the DelegatedSubnet resource." - } - }, - "x-ms-azure-resource": true - }, - "DelegatedSubnetParameters": { - "description": "DelegatedSubnet Parameters", - "type": "object", - "properties": { - "controllerID": { - "type": "string", - "description": "Delegated Network Controller ARM resource ID" - } - } - }, - "DelegatedSubnetList": { - "description": "An array of Delegated subnets resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DelegatedSubnet" - }, - "description": "An array of Delegated subnets resources." - } - }, - "required": [ - "value" - ] - }, - "DelegatedSubnet": { - "description": "Delegated subnet details", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DelegatedSubnetResponseProperties", - "description": "Properties of the delegated subnet request" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DelegatedSubnetResource" - } - ] - }, - "DelegatedSubnetResponseProperties": { - "description": "Properties of delegated subnet resource.", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "Deleting", - "Succeeded", - "Failed", - "Provisioning" - ], - "x-ms-enum": { - "name": "DelegatedSubnetState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current state of delegated subnet resource." - }, - "resourceGuid": { - "type": "string", - "description": "Guid for the resource(delegatedSubnet) created" - } - } - }, - "ErrorResponse": { - "description": "Error response.", - "properties": { - "error": { - "description": "Error description", - "$ref": "#/definitions/ErrorDefinition" - } - } - }, - "ErrorDefinition": { - "description": "Error definition.", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error.", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Internal error details.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDefinition" - }, - "readOnly": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "A unique identifier for a 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": "The client API version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." - }, - "resourceNameParameter": { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-z][a-z0-9]*$", - "minLength": 3, - "maxLength": 63, - "x-ms-parameter-location": "method", - "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." - }, - "vnetNameParameter": { - "name": "vnetName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the virtual network. This name must be at least 1 character in length, and no more than 90." - }, - "subnetNameParameter": { - "name": "subnetName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the delegated subnet. This name must be at least 1 character in length, and no more than 90." - } - } -} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json new file mode 100644 index 000000000000..c021fb9165bc --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json @@ -0,0 +1,506 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "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.DelegatedNetwork/controller/{resourceName}": { + "get": { + "description": "Gets details about the specified dnc controller.", + "x-ms-examples": { + "Get details of a controller": { + "$ref": "./examples/getController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create a dnc controller", + "x-ms-examples": { + "Create controller": { + "$ref": "./examples/putController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DelegatedController" + }, + "description": "controller type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "201": { + "description": "InProgress. The operation is still in progress.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes the DNC controller", + "x-ms-examples": { + "Delete controller": { + "$ref": "./examples/deleteController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Update dnc controller", + "x-ms-examples": { + "update controller": { + "$ref": "./examples/patchController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Patch", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ControllerResourceUpdateParameters" + }, + "description": "controller type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/controllers": { + "get": { + "tags": [ + "DelegatedControllers" + ], + "description": "Get all the delegatedController resources in a subscription.", + "operationId": "DelegatedNetwork_ListBySubscription", + "x-ms-examples": { + "Get DelegatedController resources by subscription": { + "$ref": "./examples/controllerListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedControllers in the subscription.", + "schema": { + "$ref": "#/definitions/DelegatedControllers" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controllers": { + "get": { + "tags": [ + "DelegatedControllers" + ], + "description": "Get all the delegatedController resources in a resource group.", + "operationId": "DelegatedNetwork_ListByResourceGroup", + "x-ms-examples": { + "Get DelegatedNetwork resources by resource group": { + "$ref": "./examples/controllerListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the delegatedControllers in the resource group.", + "schema": { + "$ref": "#/definitions/DelegatedControllers" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ControllerResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ControllerResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "DelegatedControllers": { + "description": "An array of Delegated controller resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedController" + }, + "description": "An array of Delegated controller resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of controllers.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DelegatedController": { + "description": "Represents an instance of a DNC controller.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControllerResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/DelegatedControllerProperties", + "description": "Properties of the provision operation request." + } + } + }, + "DelegatedControllerProperties": { + "description": "Properties of Delegated controller resource.", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "ControllerState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of dnc controller resource." + }, + "dncAppId": { + "type": "string", + "readOnly": true, + "description": "dnc application id should be used by customer to authenticate with dnc gateway." + }, + "dncTenantId": { + "type": "string", + "readOnly": true, + "description": "tenant id of dnc application id" + }, + "dncEndpoint": { + "type": "string", + "readOnly": true, + "description": "dnc endpoint url that customers can use to connect to" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a 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": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json new file mode 100644 index 000000000000..227454d9adc8 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json @@ -0,0 +1,520 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "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.DelegatedNetwork/delegatedSubnets/{resourceName}": { + "get": { + "description": "Gets details about the specified dnc DelegatedSubnet Link.", + "x-ms-examples": { + "Get details of a delegated subnet": { + "$ref": "./examples/getDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Put delegated subnet resource", + "x-ms-examples": { + "put delegated subnet": { + "$ref": "./examples/putDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_PutDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + }, + "description": "Delegated subnet details." + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "201": { + "description": "InProgress. The operation is still in progress", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Patch delegated subnet resource", + "x-ms-examples": { + "patch delegated subnet": { + "$ref": "./examples/patchDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_PatchDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceUpdateParameters" + }, + "description": "Delegated subnet details." + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Delete dnc DelegatedSubnet.", + "x-ms-examples": { + "delete delegated subnet": { + "$ref": "./examples/deleteDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_DeleteDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedSubnets": { + "get": { + "tags": [ + "DelegatedSubnets" + ], + "description": "Get all the DelegatedSubnets resources in a subscription.", + "operationId": "DelegatedSubnetService_ListBySubscription", + "x-ms-examples": { + "Get DelegatedSubnets resources by subscription": { + "$ref": "./examples/delegatedSubnetListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the subscription.", + "schema": { + "$ref": "#/definitions/DelegatedSubnets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets": { + "get": { + "tags": [ + "DelegatedSubnets" + ], + "description": "Get all the DelegatedSubnets resources in a resource group.", + "operationId": "DelegatedSubnetService_ListByResourceGroup", + "x-ms-examples": { + "Get DelegatedSubnets resources by resource group": { + "$ref": "./examples/delegatedSubnetListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the resource group.", + "schema": { + "$ref": "#/definitions/DelegatedSubnets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "DelegatedSubnetResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "DelegatedSubnets": { + "description": "An array of DelegatedSubnet resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnet" + }, + "description": "An array of DelegatedSubnet resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of DelegatedSubnet resources.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DelegatedSubnet": { + "description": "Represents an instance of a orchestrator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DelegatedSubnetResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/DelegatedSubnetProperties", + "description": "Properties of the provision operation request." + } + } + }, + "DelegatedSubnetProperties": { + "description": "Properties of delegated subnet", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "DelegatedSubnetState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of dnc delegated subnet resource." + }, + "subnetDetails": { + "description": "orchestrator details", + "$ref": "#/definitions/subnetDetails" + }, + "controllerDetails": { + "description": "controller details", + "$ref": "#/definitions/controllerDetails" + } + } + }, + "subnetDetails": { + "description": "Properties of orchestrator", + "type": "object", + "properties": { + "id": { + "description": "subnet arm resource id", + "type": "string" + } + } + }, + "controllerDetails": { + "description": "controller details", + "type": "object", + "properties": { + "id": { + "description": "controller arm resource id", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a 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": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json similarity index 73% rename from specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json rename to specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json index 4ef9119e545b..a81f2d4d5193 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json @@ -10,13 +10,15 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller1", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json similarity index 72% rename from specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json rename to specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json index 1ea3ec7ab0c8..5c58a73c6761 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json @@ -9,13 +9,15 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller1", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json index 06cd0fa9225e..d56a67b6d20b 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json @@ -34,6 +34,33 @@ "description": "Delete a Controller Service instance." } }, + { + "name": "Microsoft.DelegatedNetwork/orchestratorInstances/write", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Create or update a orchestratorInstance.", + "description": "Create or update a orchestratorInstance." + } + }, + { + "name": "Microsoft.DelegatedNetwork/controller/read", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Get a orchestratorInstances.", + "description": "Get a orchestratorInstance." + } + }, + { + "name": "Microsoft.DelegatedNetwork/controller/delete", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Delete a orchestratorInstance.", + "description": "Delete a orchestratorInstance." + } + }, { "name": "Microsoft.DelegatedNetwork/delegatedSubnets/write", "display": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json index 3118b8b5b991..8e0b0c7846e4 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json @@ -10,13 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json index eac3db04c096..7eb3dd2c65ef 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json @@ -14,8 +14,14 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json index dbc0056a454b..3b80be1a636d 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview" }, "responses": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json index b1e8c5f1c8bb..ae6a8d624d0f 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json @@ -2,13 +2,8 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", - "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" - } + "api-version": "2020-08-08-preview" }, "responses": { "200": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json new file mode 100644 index 000000000000..826523d95420 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "k8stest1", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "description": "OK." + }, + "202": { + "headers": {}, + "description": "Accepted." + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json index 6fa0fd517f29..f583f14e4985 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json @@ -2,20 +2,22 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json index 79100cab522b..fe8dc64cd511 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json @@ -2,8 +2,6 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview" }, @@ -11,13 +9,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json new file mode 100644 index 000000000000..7c0e763848c8 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json new file mode 100644 index 000000000000..e4077f80797c --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "50016170-c839-41ba-a724-51e9df440b9e", + "api-version": "2020-08-08-preview", + "resourceGroupName": "testRG" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + ] + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json new file mode 100644 index 000000000000..c8a00c1bd581 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "50016170-c839-41ba-a724-51e9df440b9e", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + ] + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json index 629ac7b2f344..9f9f3614ac45 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json @@ -2,15 +2,11 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview", - "controllerParameters": { - "controllerType": "Kubernetes", - "properties": { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" + "parameters": { + "tags": { + "key": "value" } } }, @@ -18,28 +14,21 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", + "tags": { + "key": "value" + }, "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } - }, - "201": { - "headers": {}, - "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", - "location": "West US", - "name": "dnctestcontroller", - "type": "Microsoft.DelegatedNetwork/controller", - "properties": { - "state": "Provisioning" - } - } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json index 9441a459a8d6..9c2462969f5f 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json @@ -2,37 +2,34 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + "parameters": { + "tags": { + "key": "value" + } } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", - "location": "West US", - "name": "delegated1", - "type": "Microsoft.DelegatedNetwork/delegatedSubnets", - "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" - } - } - }, - "201": { - "headers": {}, - "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", + "tags": { + "key": "value" + }, "properties": { - "state": "Provisioning" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json new file mode 100644 index 000000000000..8cabeee2c9c5 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview", + "parameters": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "tags": { + "key": "value" + }, + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json index 629ac7b2f344..77ec462dc3a3 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json @@ -2,29 +2,25 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview", - "controllerParameters": { - "controllerType": "Kubernetes", - "properties": { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" - } + "parameters": { + "location": "West US" } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } @@ -32,12 +28,12 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Provisioning" + "provisioningState": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json index 9441a459a8d6..ed8fa91a8363 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json @@ -2,37 +2,49 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + "parameters": { + "location": "West US", + "properties": { + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } + } } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } }, "201": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Provisioning" + "provisioningState": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json new file mode 100644 index 000000000000..d98e3b7c2926 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview", + "parameters": { + "location": "West US", + "kind": "Kubernetes", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "properties": { + "provisioningState": "Provisioning", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json new file mode 100644 index 000000000000..3c101da6934e --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json @@ -0,0 +1,194 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "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.DelegatedNetwork/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available DelegatedNetwork service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get available operations": { + "$ref": "./examples/delegatedNetworkOperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of request to list controller operations.It contains a list of operations and a URL link to get the next set of results", + "type": "object", + "properties": { + "value": { + "type": "array", + "uniqueItems": false, + "readOnly": true, + "description": "List of operations supported by the Microsoft.DelegatedNetwork resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "Operation": { + "description": "Microsoft.DelegatedNetwork REST API operation definition", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Gets or sets a value indicating whether the operation is a data action or not.", + "type": "boolean" + }, + "display": { + "description": "Operation properties display", + "$ref": "#/definitions/OperationDisplay" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.DelegatedNetwork.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: controller, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: create, get, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The client API version." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json new file mode 100644 index 000000000000..82e58c69c10c --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json @@ -0,0 +1,567 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "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.DelegatedNetwork/orchestrators/{resourceName}": { + "get": { + "description": "Gets details about the orchestrator instance.", + "x-ms-examples": { + "Get details of a orchestratorInstance": { + "$ref": "./examples/getOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create a orchestrator instance", + "x-ms-examples": { + "Create orchestrator instance": { + "$ref": "./examples/putOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Orchestrator" + }, + "description": "OrchestratorInstance type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "201": { + "description": "InProgress. The operation is still in progress.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes the Orchestrator Instance", + "x-ms-examples": { + "Delete Orchestrator Instance": { + "$ref": "./examples/deleteOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Update Orchestrator Instance", + "x-ms-examples": { + "update Orchestrator Instance": { + "$ref": "./examples/patchOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Patch", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrchestratorResourceUpdateParameters" + }, + "description": "OrchestratorInstance update parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/orchestrators": { + "get": { + "tags": [ + "OrchestratorInstanceList" + ], + "description": "Get all the orchestratorInstance resources in a subscription.", + "operationId": "OrchestratorInstanceService_ListBySubscription", + "x-ms-examples": { + "Get orchestratorInstance resources by subscription": { + "$ref": "./examples/orchestratorInstanceListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstance in the subscription.", + "schema": { + "$ref": "#/definitions/Orchestrators" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators": { + "get": { + "tags": [ + "OrchestratorInstanceList" + ], + "description": "Get all the OrchestratorInstances resources in a resource group.", + "operationId": "OrchestratorInstanceService_ListByResourceGroup", + "x-ms-examples": { + "Get OrchestratorInstance resources by resource group": { + "$ref": "./examples/orchestratorInstanceListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstances in the resource group.", + "schema": { + "$ref": "#/definitions/Orchestrators" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OrchestratorResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "kind": { + "type": "string", + "description": "The kind of workbook. Choices are user and shared.", + "enum": [ + "Kubernetes" + ], + "x-ms-enum": { + "name": "OrchestratorKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/OrchestratorIdentity", + "description": "The identity of the orchestrator" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "required": [ + "kind" + ], + "x-ms-azure-resource": true + }, + "OrchestratorResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "Orchestrators": { + "description": "An array of OrchestratorInstance resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Orchestrator" + }, + "description": "An array of OrchestratorInstance resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of orchestrators.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "Orchestrator": { + "description": "Represents an instance of a orchestrator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OrchestratorResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OrchestratorResourceProperties", + "description": "Properties of the provision operation request." + } + } + }, + "OrchestratorResourceProperties": { + "description": "Properties of orchestrator", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "OrchestratorInstanceState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of orchestratorInstance resource." + }, + "orchestratorAppId": { + "description": "AAD ID used with apiserver", + "type": "string" + }, + "orchestratorTenantId": { + "description": "TenantID of server App ID", + "type": "string" + }, + "clusterRootCA": { + "description": "RootCA certificate of kubernetes cluster base64 encoded", + "type": "string" + }, + "apiServerEndpoint": { + "description": "K8s APIServer url", + "type": "string" + }, + "controllerDetails": { + "description": "controller details", + "$ref": "#/definitions/ControllerDetails" + } + }, + "required": [ + "controllerDetails" + ] + }, + "OrchestratorIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by orchestrator." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by orchestrator." + }, + "type": { + "type": "string", + "description": "The type of identity used for orchestrator cluster. Type 'SystemAssigned' will use an implicitly created identity orchestrator clusters", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "ControllerDetails": { + "description": "controller details", + "type": "object", + "properties": { + "id": { + "description": "controller arm resource id", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a 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": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/readme.md b/specification/dnc/resource-manager/readme.md index 6b1b089bee9f..cec8467edf34 100644 --- a/specification/dnc/resource-manager/readme.md +++ b/specification/dnc/resource-manager/readme.md @@ -36,7 +36,10 @@ These settings apply only when `--tag=package-2020-08-08-preview` is specified o ``` yaml $(tag) == 'package-2020-08-08-preview' input-file: -- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json ``` --- @@ -114,4 +117,3 @@ generate-interface: true See configuration in [readme.python.md](./readme.python.md) -