diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsDeleteDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsDeleteDefault.json new file mode 100644 index 000000000000..6ecd9b45175b --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsDeleteDefault.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetCustom.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetCustom.json new file mode 100644 index 000000000000..e2a283ff0ea4 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetCustom.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "custom" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetDefault.json new file mode 100644 index 000000000000..32bd9c005462 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsGetDefault.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsList.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsList.json new file mode 100644 index 000000000000..e5962a119dc5 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default" + } + }, + { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + ] + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPatchDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPatchDefault.json new file mode 100644 index 000000000000..b80a973b8d97 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPatchDefault.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "default", + "EndpointResource": { + "properties": { + "type": "default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListCredentials.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListCredentials.json new file mode 100644 index 000000000000..e5dae0c0e5d9 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListCredentials.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "default", + "expiresin": 10800, + "ListCredentialsRequest": { + "serviceName": "SSH" + } + }, + "responses": { + "200": { + "body": { + "relay": { + "namespaceName": "azgnrelay-eastus-l1", + "namespaceNameSuffix": "servicebus.windows.net", + "hybridConnectionName": "microsoft.kubernetes/connectedclusters/a0e1fd7d1d974ddf6b11a952d67679c9f12c006eee16861857a8268da4eb1498/1619989456957411072", + "accessKey": "SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.kubernetes%2Fconnectedclusters%2Fa0e1fd7d1d974ddf6b11a952d67679c9f12c006eee16861857a8268da4eb1498%2F1619989456957411072%2F&sig=WxDwPF6AmmODaMHNnBGDSm773UG%2B%2Be", + "expiresOn": 1620000256, + "serviceConfigurationToken": "SSHvjqH=pTlKql=RtMGw/-k5VFBxSYHIiq5ZgbGFcLkNrDNz5fDsinCN2zkG" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json new file mode 100644 index 000000000000..430bf536e449 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/arcGroup/providers/Microsoft.ArcPlaceHolder/ProvisionedClusters/cluster0", + "api-version": "2023-03-15", + "endpointName": "default", + "expiresin": 10800 + }, + "responses": { + "200": { + "body": { + "relay": { + "namespaceName": "relaynamespace", + "namespaceNameSuffix": "servicebus.windows.net", + "hybridConnectionName": "microsoft.arcplaceholder/provisionedclusters/000/1619989456957411072", + "accessKey": "SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.provisionedcluster%hci", + "expiresOn": 1620000256 + }, + "ingress": { + "hostname": "clusterhostname", + "aadProfile": { + "serverId": "6256c85f-0aad-4d50-b960-e6e9b21efe35", + "tenantId": "hy657tgh-8d16-42db-81b7-1234hygt67hy5" + } + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListManagedProxyDetails.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListManagedProxyDetails.json new file mode 100644 index 000000000000..c46ed6d97e39 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListManagedProxyDetails.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/arcGroup/providers/Microsoft.Compute/virtualMachines/vm00006", + "api-version": "2023-03-15", + "endpointName": "default", + "ManagedProxyRequest": { + "service": "127.0.0.1:65035", + "hostname": "r.proxy.arc.com", + "serviceName": "WAC" + } + }, + "responses": { + "200": { + "body": { + "proxy": "uid.r.proxy.arc.com", + "expiresOn": 1620000256 + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutCustom.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutCustom.json new file mode 100644 index 000000000000..f325b85c5522 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutCustom.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "custom", + "EndpointResource": { + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/custom", + "name": "custom", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "custom", + "resourceId": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.Relay/namespaces/custom-relay-namespace", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutDefault.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutDefault.json new file mode 100644 index 000000000000..aa5461c0ca6f --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPutDefault.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine", + "api-version": "2023-03-15", + "endpointName": "default", + "EndpointResource": { + "properties": { + "type": "default", + "serviceConfigurations": [ + { + "serviceName": "SSH", + "port": "22" + }, + { + "serviceName": "WAC", + "port": "80" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/hybridRG/providers/Microsoft.HybridCompute/machines/testMachine/providers/Microsoft.HybridConnectivity/endpoints/default", + "name": "default", + "type": "Microsoft.HybridConnectivity/endpoints", + "properties": { + "type": "default", + "serviceConfigurations": [ + { + "serviceName": "SSH", + "port": "22" + }, + { + "serviceName": "WAC", + "port": "80" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/OperationsList.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/OperationsList.json new file mode 100644 index 000000000000..69ae3aaa6ec9 --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/OperationsList.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HybridConnectivity/operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Operations", + "operation": "Get operations", + "description": "Get the list of Operations" + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Get/List endpoints", + "description": "Get or list of endpoints to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Create/Update endpoint", + "description": "Create or update the endpoint to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "Delete endpoint", + "description": "Deletes the endpoint access to the target resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/listCredentials/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "List credentials for endpoint access", + "description": "List the endpoint access credentials to the resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/endpoints/listIngressGatewayCredentials/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "endpoints", + "operation": "List credentials for ingress gateway", + "description": "List the ingress gateway credentials to the resource." + } + }, + { + "name": "Microsoft.HybridConnectivity/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Microsoft.HybridConnectivity", + "operation": "Register the Microsoft.HybridConnectivity", + "description": "Register the subscription for Microsoft.HybridConnectivity" + } + }, + { + "name": "Microsoft.HybridConnectivity/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.HybridConnectivity", + "resource": "Microsoft.HybridConnectivity", + "operation": "Unregister the Microsoft.HybridConnectivity", + "description": "Unregister the subscription for Microsoft.HybridConnectivity" + } + } + ] + } + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json new file mode 100644 index 000000000000..5550e8b3085a --- /dev/null +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json @@ -0,0 +1,762 @@ +{ + "swagger": "2.0", + "info": { + "title": "Hybrid Connectivity Management API", + "description": "REST API for Hybrid Connectivity", + "version": "2023-03-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.HybridConnectivity/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the available Hybrid Connectivity REST API operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityOperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "List of endpoints to the target resource.", + "operationId": "Endpoints_List", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsGet": { + "$ref": "./examples/EndpointsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "List of endpoints.", + "schema": { + "$ref": "#/definitions/EndpointsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets the endpoint to the resource.", + "operationId": "Endpoints_Get", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsGetDefault": { + "$ref": "./examples/EndpointsGetDefault.json" + }, + "HybridConnectivityEndpointsGetCustom": { + "$ref": "./examples/EndpointsGetCustom.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "Endpoint details", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Create or update the endpoint to the target resource.", + "operationId": "Endpoints_CreateOrUpdate", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPutDefault": { + "$ref": "./examples/EndpointsPutDefault.json" + }, + "HybridConnectivityEndpointsPutCustom": { + "$ref": "./examples/EndpointsPutCustom.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "EndpointResource", + "description": "Endpoint details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Endpoint details.", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Update the endpoint to the target resource.", + "operationId": "Endpoints_Update", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPatchDefault": { + "$ref": "./examples/EndpointsPatchDefault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "EndpointResource", + "description": "Endpoint details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Endpoint resource.", + "schema": { + "$ref": "#/definitions/EndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes the endpoint access to the target resource.", + "operationId": "Endpoints_Delete", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsDeleteDefault": { + "$ref": "./examples/EndpointsDeleteDefault.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "The endpoint is deleted successfully." + }, + "204": { + "description": "The endpoint has been deleted already." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Gets the endpoint access credentials to the resource.", + "operationId": "Endpoints_ListCredentials", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListCredentials": { + "$ref": "./examples/EndpointsPostListCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/AccessTokenExpirationParameter" + }, + { + "name": "ListCredentialsRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/ListCredentialsRequest" + }, + "description": "Object of type ListCredentialsRequest" + } + ], + "responses": { + "200": { + "description": "Endpoint access credentials", + "schema": { + "$ref": "#/definitions/EndpointAccessResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listIngressGatewayCredentials": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Gets the ingress gateway endpoint credentials ", + "operationId": "Endpoints_ListIngressGatewayCredentials", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListIngressGatewayCredentials": { + "$ref": "./examples/EndpointsPostListIngressGatewayCredentials.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "#/parameters/AccessTokenExpirationParameter" + } + ], + "responses": { + "200": { + "description": "Ingress gateway access", + "schema": { + "$ref": "#/definitions/IngressGatewayResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + }, + "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Fetches the managed proxy details ", + "operationId": "Endpoints_ListManagedProxyDetails", + "produces": [ + "application/json" + ], + "x-ms-examples": { + "HybridConnectivityEndpointsPostListManagedProxyDetails": { + "$ref": "./examples/EndpointsPostListManagedProxyDetails.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "name": "ManagedProxyRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedProxyRequest" + }, + "description": "Object of type ManagedProxyRequest" + } + ], + "responses": { + "200": { + "description": "Managed Proxy", + "schema": { + "$ref": "#/definitions/ManagedProxyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "RelayNamespaceAccessProperties": { + "type": "object", + "description": "Azure relay hybrid connection access properties", + "required": [ + "namespaceName", + "namespaceNameSuffix", + "hybridConnectionName" + ], + "properties": { + "namespaceName": { + "type": "string", + "description": "The namespace name.", + "minLength": 1, + "maxLength": 200 + }, + "namespaceNameSuffix": { + "type": "string", + "description": "The suffix domain name of relay namespace.", + "minLength": 1, + "maxLength": 100 + }, + "hybridConnectionName": { + "type": "string", + "description": "Azure Relay hybrid connection name for the resource." + }, + "accessKey": { + "type": "string", + "description": "Access key for hybrid connection.", + "readOnly": true + }, + "expiresOn": { + "type": "integer", + "format": "int64", + "description": "The expiration of access key in unix time." + }, + "serviceConfigurationToken": { + "type": "string", + "description": "The token to access the enabled service.", + "x-ms-secret": true + } + } + }, + "IngressGatewayResource": { + "description": "The ingress gateway access credentials", + "type": "object", + "properties": { + "relay": { + "$ref": "#/definitions/RelayNamespaceAccessProperties", + "x-ms-client-flatten": true + }, + "ingress": { + "$ref": "#/definitions/IngressProfileProperties", + "x-ms-client-flatten": true + } + } + }, + "IngressProfileProperties": { + "type": "object", + "description": "Ingress gateway profile", + "required": [ + "hostname", + "aadProfile" + ], + "properties": { + "hostname": { + "type": "string", + "description": "The ingress hostname." + }, + "aadProfile": { + "$ref": "#/definitions/AADProfileProperties", + "x-ms-client-flatten": true + } + } + }, + "AADProfileProperties": { + "type": "object", + "description": "The AAD Profile", + "required": [ + "serverId", + "tenantId" + ], + "properties": { + "serverId": { + "type": "string", + "description": "The arc ingress gateway server app id." + }, + "tenantId": { + "type": "string", + "description": "The target resource home tenant id." + } + } + }, + "EndpointAccessResource": { + "description": "The endpoint access for the target resource.", + "type": "object", + "properties": { + "relay": { + "$ref": "#/definitions/RelayNamespaceAccessProperties", + "x-ms-client-flatten": true + } + } + }, + "EndpointProperties": { + "type": "object", + "description": "Endpoint details", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of endpoint.", + "enum": [ + "default", + "custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + }, + "resourceId": { + "type": "string", + "description": "The resource Id of the connectivity endpoint (optional)." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The resource provisioning state." + }, + "serviceConfigurations": { + "type": "array", + "description": "The enabled service configurations.", + "items": { + "$ref": "#/definitions/ServiceConfiguration" + }, + "x-ms-identifiers": [ + "serviceName" + ] + } + } + }, + "ServiceConfiguration": { + "description": "The service configuration object definition", + "properties": { + "serviceName": { + "type": "string", + "description": "The type of service enabled.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + }, + "port": { + "type": "string", + "description": "The port on which service is enabled." + } + }, + "type": "object" + }, + "EndpointResource": { + "description": "The endpoint for the target resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "description": "System data of endpoint resource", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "x-ms-client-flatten": true + }, + "properties": { + "description": "The endpoint properties.", + "$ref": "#/definitions/EndpointProperties", + "x-ms-client-flatten": true + } + } + }, + "EndpointsList": { + "description": "The list of endpoints.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of endpoints list.", + "type": "string" + }, + "value": { + "description": "The list of endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointResource" + } + } + } + }, + "ManagedProxyResource": { + "type": "object", + "description": "Managed Proxy", + "required": [ + "proxy", + "expiresOn" + ], + "properties": { + "proxy": { + "type": "string", + "description": "The short lived proxy name." + }, + "expiresOn": { + "type": "integer", + "format": "int64", + "description": "The expiration time of short lived proxy name in unix epoch." + } + } + }, + "ManagedProxyRequest": { + "type": "object", + "description": "Represent ManageProxy Request object.", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "string", + "description": "The name of the service." + }, + "hostname": { + "type": "string", + "description": "The target host name." + }, + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } + }, + "ListCredentialsRequest": { + "type": "object", + "description": "Represent ListCredentials Request object.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified Azure Resource manager identifier of the resource to be connected.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "EndpointNameParameter": { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The endpoint name.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "AccessTokenExpirationParameter": { + "name": "expiresin", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "default": 10800, + "minimum": 600, + "maximum": 10800, + "description": "The is how long the endpoint access token is valid (in seconds).", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridconnectivity/resource-manager/readme.md b/specification/hybridconnectivity/resource-manager/readme.md index a83f579d81f5..e4307914ac46 100644 --- a/specification/hybridconnectivity/resource-manager/readme.md +++ b/specification/hybridconnectivity/resource-manager/readme.md @@ -24,23 +24,18 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the hybridconnectivity. -```yaml -openapi-type: arm -openapi-subtype: rpaas -tag: package-2021-10-06-preview -``` -```yaml +``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-05-01-preview +tag: package-2023-03-15 ``` ### Tag: package-2021-10-06-preview These settings apply only when `--tag=package-2021-10-06-preview` is specified on the command line. -```yaml $(tag) == 'package-2021-10-06-preview' +``` yaml $(tag) == 'package-2021-10-06-preview' input-file: - Microsoft.HybridConnectivity/preview/2021-10-06-preview/hybridconnectivity.json ``` @@ -49,11 +44,19 @@ input-file: These settings apply only when `--tag=package-2022-05-01-preview` is specified on the command line. -```yaml $(tag) == 'package-2022-05-01-preview' +``` yaml $(tag) == 'package-2022-05-01-preview' input-file: - Microsoft.HybridConnectivity/preview/2022-05-01-preview/hybridconnectivity.json ``` +### Tag: package-2023-03-15 + +These settings apply only when `--tag=package-2023-03-15` is specified on the command line. + +``` yaml $(tag) == 'package-2023-03-15' +input-file: + - Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json +``` --- # Code Generation @@ -63,7 +66,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -```yaml $(swagger-to-sdk) +``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-python-track2 @@ -74,6 +77,7 @@ swagger-to-sdk: - repo: azure-cli-extensions - repo: azure-powershell ``` + ## Az See configuration in [readme.az.md](./readme.az.md)