diff --git a/custom-words.txt b/custom-words.txt index 8dd85b9a6ed8..0786c3700092 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -148,6 +148,7 @@ autoscaling Avro avrodeflate AZFW +AZNB azns azpkg azureaccounts @@ -1021,6 +1022,7 @@ nopublicipaddresses northcentralus northeurope nostore +notebookapis notificationchannels notificationhubs notstarted @@ -1566,6 +1568,7 @@ testall testallroutes testnew testnewroute +testpl testresultfile textanalytics TFIDF diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json new file mode 100644 index 000000000000..3d9864c0be9e --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json new file mode 100644 index 000000000000..3c63585808a9 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + }, + "204": {} + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json new file mode 100644 index 000000000000..5d5fa97a066e --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json new file mode 100644 index 000000000000..32ccd88715a7 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource2", + "name": "testResource2", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "bcc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + ] + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json new file mode 100644 index 000000000000..bf9538056f11 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "primaryAccessKey": "42c43f86f937487dbc84256fab515bf2d80754b249154ded8ede0f5ded3733be", + "secondaryAccessKey": "1cef8965a0224bd896d27f87a7cabf1687e99f6412cd4c2ca25e5908d2105f79", + "hostname": "Azure Notebooks" + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json new file mode 100644 index 000000000000..eaaa8c198c6a --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceName": "testPL1-1", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkId": "testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + }, + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json new file mode 100644 index 000000000000..e5382984121a --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "resourceName": "testPL1-1", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkId": "testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "parameters": { + "properties": { + "hostname": "Azure Notebooks", + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1", + "privateLinkServiceProxies": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000//resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1/privateLinkServiceProxies/testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "groupConnectivityInformation": [ + { + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member", + "customerVisibleFqdns": [ + "testpl1.notebooks-test.azure.net" + ], + "internalFqdn": "privatelink.notebookapis-dev2.azure.com" + } + ] + } + ], + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1", + "privateLinkServiceProxies": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000//resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1/privateLinkServiceProxies/testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "groupConnectivityInformation": [ + { + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member", + "customerVisibleFqdns": [ + "testpl1.notebooks-test.azure.net" + ], + "internalFqdn": "privatelink.notebookapis-dev2.azure.com" + } + ] + } + ], + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json new file mode 100644 index 000000000000..6fa544b75490 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json @@ -0,0 +1,808 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Notebooks Resource Management Client", + "version": "2019-10-11-preview", + "title": "NotebookResourceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Notebooks/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Notebooks REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_Get", + "x-ms-examples": { + "Get Notebook Proxy": { + "$ref": "./examples/NBResourceGet.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get the properties of the specified NotebookProxy.", + "description": "Gets the properties of the specified NotebookProxy resource in the specified subscription and resource group. This operation returns properties of specified NotebookProxy resource including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_CreateOrUpdate", + "x-ms-examples": { + "Create Notebook Proxy": { + "$ref": "./examples/NBResourceCreate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "summary": "Create or update NotebookProxy resource.", + "description": "Create or update NotebookProxy resource with specified configuration.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "description": "The properties of the NotebookProxy to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_Delete", + "x-ms-examples": { + "Delete Notebook Proxy": { + "$ref": "./examples/NBResourceDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Delete the specified NotebookProxy.", + "description": "Delete the specified NotebookProxy in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_ListByResourceGroup", + "x-ms-examples": { + "List Notebook Proxy by Resource Group": { + "$ref": "./examples/NBResourceList.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get a list of NotebookProxy resources in the specified subscription and resource group.", + "description": "Get a list of NotebookProxy resources in the specified subscription and resource group. This operation returns properties of each NotebookProxy including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Notebooks/notebookProxies": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_List", + "x-ms-examples": { + "List Notebook Proxy by Subscription": { + "$ref": "./examples/NBResourceList.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get a list of NotebookProxy resources in the specified subscription.", + "description": "Get a list of NotebookProxy resources in the specified subscription. This operation returns properties of each NotebookProxy including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/listCredentials": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_ListCredentials", + "x-ms-examples": { + "List Notebook Proxy Credentials": { + "$ref": "./examples/NBResourceListCredentials.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get the access keys of the specified NotebookProxy.", + "description": "Get the access keys of the specified NotebookProxy. in the specified subscription and resource group. This operation returns resourceId, primaryAccessKey and secondaryAccessKey.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyCredentials" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/privateEndpointConnectionProxies/{privateLinkId}": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "PostPrivateLinkIdNotebookResource", + "x-ms-examples": { + "Create Notebook Proxy Private Endpoint": { + "$ref": "./examples/NBResourcePEUpdate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateLinkId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NotebookPEResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/removePrivateLinkId/{privateLinkId}": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "RemovePrivateLinkIdNotebookResource", + "x-ms-examples": { + "Remove Notebook Proxy Private Endpoint": { + "$ref": "./examples/NBResourcePEDelete.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateLinkId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "NotebookProxy": { + "description": "A NotebookProxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NotebookResourceEntity", + "description": "The properties of NotebookProxy resource.", + "x-ms-client-flatten": true + } + } + }, + "NotebookResourceEntity": { + "description": "Properties of NotebookProxy resource", + "type": "object", + "properties": { + "resourceId": { + "description": "The unique identifier (a GUID) generated for every resource.", + "type": "string", + "readOnly": true + }, + "hostname": { + "description": "The friendly string identifier of the creator of the NotebookProxy resource.", + "type": "string" + } + } + }, + "NotebookPEResource": { + "description": "Notebooks Proxy resource with Private Link", + "type": "object", + "properties": { + "hostname": { + "description": "The friendly string identifier of the creator of the NotebookProxy resource.", + "type": "string" + }, + "connectionDetails": { + "description": "Private link connection details", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "NotebookPEResponse": { + "description": "Private Endpoint details for a Notebook Proxy resource", + "type": "object", + "properties": { + "id": { + "description": "Private endpoint id", + "type": "string" + }, + "privateLinkServiceProxies": { + "description": "Private endpoint service proxies", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointServiceProxy" + } + }, + "connectionDetails": { + "description": "Private link connection details", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "PrivateEndpointServiceProxy": { + "description": "Private Endpoint service proxy details", + "type": "object", + "properties": { + "id": { + "description": "Service proxy id", + "type": "string" + }, + "groupConnectivityInformation": { + "description": "Group connectivity information", + "type": "array", + "items": { + "$ref": "#/definitions/GroupConnectivityInformation" + } + } + } + }, + "GroupConnectivityInformation": { + "description": "Private link Group Connectivity Detail", + "type": "object", + "properties": { + "internalFqdn": { + "description": "Internal fully qualified domain name", + "type": "string" + }, + "customerVisibleFqdns": { + "description": "Customer visible fully qualified domain names", + "type": "array", + "items": { + "type": "string" + } + }, + "groupId": { + "description": "Private link group Id", + "type": "string" + }, + "memberName": { + "description": "Private link member name", + "type": "string" + } + } + }, + "ConnectionDetail": { + "description": "Private link Connection Detail", + "type": "object", + "properties": { + "id": { + "description": "Private link connection id", + "type": "string" + }, + "privateIpAddress": { + "description": "Private endpoint IP address", + "type": "string" + }, + "linkIdentifier": { + "description": "Link Id for the private link", + "type": "integer", + "format": "int32" + }, + "groupId": { + "description": "Private link group Id", + "type": "string" + }, + "memberName": { + "description": "Private link member name", + "type": "string" + } + } + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Storage/storageAccounts or Microsoft.Notebooks/notebookProxies." + } + }, + "x-ms-azure-resource": true + }, + "CloudError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "Operation": { + "description": "Azure Notebooks Proxy REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.Notebooks", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Notebook Proxy operations supported by the Azure Notebooks resource provider." + } + } + }, + "NotebookProxyListResult": { + "description": "The response containing list of NotebookProxy resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotebookProxy" + }, + "description": "The list of NotebookProxy resources." + }, + "nextLink": { + "description": "The URI that can be used to request the next list of NotebookProxy resources.", + "type": "string" + } + } + }, + "NotebookProxyCredentials": { + "description": "Credentials and other properties of NotebookProxy resource", + "type": "object", + "readOnly": true, + "properties": { + "resourceId": { + "description": "Notebook Proxy resource id", + "type": "string" + }, + "primaryAccessKey": { + "description": "The primary key of the NotebookProxy resource.", + "type": "string" + }, + "secondaryAccessKey": { + "description": "The secondary key of the NotebookProxy resource.", + "type": "string" + }, + "hostname": { + "description": "Hostname for the Notebook Proxy resource", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1 + }, + "APIVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md new file mode 100644 index 000000000000..7712f4b56527 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md @@ -0,0 +1,9 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +#cli: +# test-scenario: +# - name: Example_CreateOrUpdate +``` diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md new file mode 100644 index 000000000000..b8e37386caa2 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md @@ -0,0 +1,66 @@ +# Notebooks + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Notebooks Resource Management Client. + +--- +## Getting Started +To build the SDK for Azure Resource Management, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +--- +## Configuration + +### Basic Information +These are the global settings for the Azure Notebooks Resource Management Client. + +``` yaml +openapi-type: arm +tag: package-2019-10-11-preview +``` +### Tag: package-2019-10-11-preview + +These settings apply only when `--tag=package-2019-10-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-10-11-preview' +input-file: +- notebooks.json +``` + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - notebooks.json +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md new file mode 100644 index 000000000000..d4181ff7ef65 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.Notebooks + package-name: notebooks + package-version: 2019-10-11-preview + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/notebooks +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt/notebooks +```