{ "swagger": "2.0", "info": { "title": "Hybrid Connectivity Management API", "version": "2027-01-01", "description": "REST API for Hybrid Connectivity", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "EndpointResources" }, { "name": "ServiceConfigurationResources" }, { "name": "GenerateAwsTemplate" }, { "name": "GenerateGcpTemplate" }, { "name": "PublicCloudConnectors" }, { "name": "SolutionConfigurations" }, { "name": "Inventory" }, { "name": "SolutionTypes" } ], "paths": { "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints": { "get": { "operationId": "Endpoints_List", "tags": [ "EndpointResources" ], "description": "List of endpoints to the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/EndpointsList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsGet - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}": { "get": { "operationId": "Endpoints_Get", "tags": [ "EndpointResources" ], "description": "Gets the endpoint to the resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EndpointResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsGetCustom - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_Get_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsGetCustom - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_Get_MinimumSet_Gen.json" } } }, "put": { "operationId": "Endpoints_CreateOrUpdate", "tags": [ "EndpointResources" ], "description": "Create or update the endpoint to the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "EndpointResource", "in": "body", "description": "Endpoint details", "required": true, "schema": { "$ref": "#/definitions/EndpointResource" } } ], "responses": { "200": { "description": "Resource 'EndpointResource' update operation succeeded", "schema": { "$ref": "#/definitions/EndpointResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsPutCustom - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_CreateOrUpdate_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsPutCustom - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_CreateOrUpdate_MinimumSet_Gen.json" } } }, "patch": { "operationId": "Endpoints_Update", "tags": [ "EndpointResources" ], "description": "Update the endpoint to the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "EndpointResource", "in": "body", "description": "Endpoint details", "required": true, "schema": { "$ref": "#/definitions/EndpointResource" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EndpointResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsPatchDefault - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_Update_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsPatchDefault - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_Update_MinimumSet_Gen.json" } } }, "delete": { "operationId": "Endpoints_Delete", "tags": [ "EndpointResources" ], "description": "Deletes the endpoint access to the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsDeleteDefault - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_Delete_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsDeleteDefault - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_Delete_MinimumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials": { "post": { "operationId": "Endpoints_ListCredentials", "tags": [ "EndpointResources" ], "description": "Gets the endpoint access credentials to the resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "expiresin", "in": "query", "description": "The is how long the endpoint access token is valid (in seconds).", "required": false, "type": "integer", "format": "int64", "default": 10800, "minimum": 600, "maximum": 10800 }, { "name": "ListCredentialsRequest", "in": "body", "description": "Object of type ListCredentialsRequest", "required": false, "schema": { "$ref": "#/definitions/ListCredentialsRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EndpointAccessResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsPostListCredentials - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_ListCredentials_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsPostListCredentials - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_ListCredentials_MinimumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listIngressGatewayCredentials": { "post": { "operationId": "Endpoints_ListIngressGatewayCredentials", "tags": [ "EndpointResources" ], "description": "Gets the ingress gateway endpoint credentials ", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "expiresin", "in": "query", "description": "The is how long the endpoint access token is valid (in seconds).", "required": false, "type": "integer", "format": "int64", "default": 10800, "minimum": 600, "maximum": 10800 }, { "name": "ListIngressGatewayCredentialsRequest", "in": "body", "description": "Object of type ListIngressGatewayCredentialsRequest", "required": false, "schema": { "$ref": "#/definitions/ListIngressGatewayCredentialsRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/IngressGatewayResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsPostListIngressGatewayCredentials - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_ListIngressGatewayCredentials_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsPostListIngressGatewayCredentials - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_ListIngressGatewayCredentials_MinimumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails": { "post": { "operationId": "Endpoints_ListManagedProxyDetails", "tags": [ "EndpointResources" ], "description": "Fetches the managed proxy details ", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "ManagedProxyRequest", "in": "body", "description": "Object of type ManagedProxyRequest", "required": true, "schema": { "$ref": "#/definitions/ManagedProxyRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedProxyResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsPostListManagedProxyDetails - generated by [MaximumSet] rule": { "$ref": "./examples/Endpoints_ListManagedProxyDetails_MaximumSet_Gen.json" }, "HybridConnectivityEndpointsPostListManagedProxyDetails - generated by [MinimumSet] rule": { "$ref": "./examples/Endpoints_ListManagedProxyDetails_MinimumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations": { "get": { "operationId": "ServiceConfigurations_ListByEndpointResource", "tags": [ "ServiceConfigurationResources" ], "summary": "Lists of all the services associated with endpoint resource.", "description": "API to enumerate registered services in service configurations under a Endpoint Resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ServiceConfigurationList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GetClustersExample - generated by [MaximumSet] rule": { "$ref": "./examples/ServiceConfigurations_ListByEndpointResource_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}": { "get": { "operationId": "ServiceConfigurations_Get", "tags": [ "ServiceConfigurationResources" ], "description": "Gets the details about the service to the resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "serviceConfigurationName", "in": "path", "description": "The service name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceConfigurationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityEndpointsServiceconfigurationsGetSSH - generated by [MaximumSet] rule": { "$ref": "./examples/ServiceConfigurations_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "ServiceConfigurations_CreateOrupdate", "tags": [ "ServiceConfigurationResources" ], "description": "Create or update a service in serviceConfiguration for the endpoint resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "serviceConfigurationName", "in": "path", "description": "The service name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "ServiceConfigurationResource", "in": "body", "description": "Service details", "required": true, "schema": { "$ref": "#/definitions/ServiceConfigurationResource" } } ], "responses": { "200": { "description": "Resource 'ServiceConfigurationResource' update operation succeeded", "schema": { "$ref": "#/definitions/ServiceConfigurationResource" } }, "201": { "description": "Resource 'ServiceConfigurationResource' create operation succeeded", "schema": { "$ref": "#/definitions/ServiceConfigurationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ServiceConfigurationsPutSSH - generated by [MaximumSet] rule": { "$ref": "./examples/ServiceConfigurations_CreateOrupdate_MaximumSet_Gen.json" } } }, "patch": { "operationId": "ServiceConfigurations_Update", "tags": [ "ServiceConfigurationResources" ], "description": "Update the service details in the service configurations of the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "serviceConfigurationName", "in": "path", "description": "The service name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "ServiceConfigurationResource", "in": "body", "description": "Service details", "required": true, "schema": { "$ref": "#/definitions/ServiceConfigurationResourcePatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceConfigurationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ServiceConfigurationsPatchSSH - generated by [MaximumSet] rule": { "$ref": "./examples/ServiceConfigurations_Update_MaximumSet_Gen.json" } } }, "delete": { "operationId": "ServiceConfigurations_Delete", "tags": [ "ServiceConfigurationResources" ], "description": "Deletes the service details to the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "endpointName", "in": "path", "description": "The endpoint name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "serviceConfigurationName", "in": "path", "description": "The service name.", "required": true, "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ServiceConfigurationsDeleteSSH - generated by [MaximumSet] rule": { "$ref": "./examples/ServiceConfigurations_Delete_MaximumSet_Gen.json" }, "ServiceConfigurationsDeleteSSH - generated by [MinimumSet] rule": { "$ref": "./examples/ServiceConfigurations_Delete_MinimumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations": { "get": { "operationId": "SolutionConfigurations_List", "tags": [ "SolutionConfigurations" ], "description": "List SolutionConfiguration resources by parent", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_List - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_List_MaximumSet_Gen.json" }, "SolutionConfigurations_List - generated by [MinimumSet] rule": { "$ref": "./examples/SolutionConfigurations_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}": { "get": { "operationId": "SolutionConfigurations_Get", "tags": [ "SolutionConfigurations" ], "description": "Get a SolutionConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_Get - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "SolutionConfigurations_CreateOrUpdate", "tags": [ "SolutionConfigurations" ], "description": "Create a SolutionConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/SolutionConfiguration" } } ], "responses": { "200": { "description": "Resource 'SolutionConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/SolutionConfiguration" } }, "201": { "description": "Resource 'SolutionConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/SolutionConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_CreateOrUpdate - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_CreateOrUpdate_MaximumSet_Gen.json" } } }, "patch": { "operationId": "SolutionConfigurations_Update", "tags": [ "SolutionConfigurations" ], "description": "Update a SolutionConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/SolutionConfigurationUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_Update - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_Update_MaximumSet_Gen.json" } } }, "delete": { "operationId": "SolutionConfigurations_Delete", "tags": [ "SolutionConfigurations" ], "description": "Delete a SolutionConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_Delete - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_Delete_MaximumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory": { "get": { "operationId": "Inventory_ListBySolutionConfiguration", "tags": [ "Inventory" ], "description": "List InventoryResource resources by SolutionConfiguration", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InventoryResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Inventory_ListBySolutionConfiguration - generated by [MaximumSet] rule": { "$ref": "./examples/Inventory_ListBySolutionConfiguration_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory/{inventoryId}": { "get": { "operationId": "Inventory_Get", "tags": [ "Inventory" ], "description": "Get a InventoryResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" }, { "name": "inventoryId", "in": "path", "description": "Inventory resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/InventoryResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Inventory_Get - generated by [MaximumSet] rule": { "$ref": "./examples/Inventory_Get_MaximumSet_Gen.json" } } } }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/syncNow": { "post": { "operationId": "SolutionConfigurations_SyncNow", "tags": [ "SolutionConfigurations" ], "description": "Trigger immediate sync with source cloud", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" }, { "name": "solutionConfiguration", "in": "path", "description": "Represent Solution Configuration Resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionConfigurations_SyncNow - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionConfigurations_SyncNow_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.HybridConnectivity/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "HybridConnectivityOperationsList - generated by [MaximumSet] rule": { "$ref": "./examples/Operations_List_MaximumSet_Gen.json" }, "HybridConnectivityOperationsList - generated by [MinimumSet] rule": { "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/generateAwsTemplate": { "post": { "operationId": "GenerateAwsTemplate_Post", "tags": [ "GenerateAwsTemplate" ], "description": "Retrieve AWS Cloud Formation template", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "generateAwsTemplateRequest", "in": "body", "description": "ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template.", "required": true, "schema": { "$ref": "#/definitions/GenerateAwsTemplateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateAwsTemplateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateAwsTemplate_Post - generated by [MaximumSet] rule": { "$ref": "./examples/GenerateAwsTemplate_Post_MaximumSet_Gen.json" }, "GenerateAwsTemplate_Post - generated by [MinimumSet] rule": { "$ref": "./examples/GenerateAwsTemplate_Post_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/generateGcpTemplate": { "post": { "operationId": "GenerateGcpTemplate_Post", "tags": [ "GenerateGcpTemplate" ], "description": "Retrieve GCP Access Control template", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "generateGcpTemplateRequest", "in": "body", "description": "ConnectorId and SolutionTypes and their properties to Generate GCP Access Control Template.", "required": true, "schema": { "$ref": "#/definitions/GenerateGcpTemplateRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GenerateGcpTemplateResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GenerateGcpTemplate_Post_MaximumSet": { "$ref": "./examples/GenerateGcpTemplate_Post_MaximumSet_Gen.json" }, "GenerateGcpTemplate_Post_MaximumSet - generated by [MinimumSet] rule": { "$ref": "./examples/GenerateGcpTemplate_Post_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/publicCloudConnectors": { "get": { "operationId": "PublicCloudConnectors_ListBySubscription", "tags": [ "PublicCloudConnectors" ], "description": "List PublicCloudConnector resources by subscription ID", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PublicCloudConnectorListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_ListBySubscription - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_ListBySubscription_MaximumSet_Gen.json" }, "PublicCloudConnectors_ListBySubscription - generated by [MinimumSet] rule": { "$ref": "./examples/PublicCloudConnectors_ListBySubscription_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/solutionTypes": { "get": { "operationId": "SolutionTypes_ListBySubscription", "tags": [ "SolutionTypes" ], "description": "List SolutionTypeResource resources by subscription ID", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionTypeResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionTypes_ListBySubscription - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionTypes_ListBySubscription_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors": { "get": { "operationId": "PublicCloudConnectors_ListByResourceGroup", "tags": [ "PublicCloudConnectors" ], "description": "List PublicCloudConnector resources by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PublicCloudConnectorListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_ListByResourceGroup - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_ListByResourceGroup_MaximumSet_Gen.json" }, "PublicCloudConnectors_ListByResourceGroup - generated by [MinimumSet] rule": { "$ref": "./examples/PublicCloudConnectors_ListByResourceGroup_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}": { "get": { "operationId": "PublicCloudConnectors_Get", "tags": [ "PublicCloudConnectors" ], "description": "Get a PublicCloudConnector", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "publicCloudConnector", "in": "path", "description": "Represent public cloud connectors resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PublicCloudConnector" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_Get - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "PublicCloudConnectors_CreateOrUpdate", "tags": [ "PublicCloudConnectors" ], "description": "Create a PublicCloudConnector", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "publicCloudConnector", "in": "path", "description": "Represent public cloud connectors resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/PublicCloudConnector" } } ], "responses": { "200": { "description": "Resource 'PublicCloudConnector' update operation succeeded", "schema": { "$ref": "#/definitions/PublicCloudConnector" } }, "201": { "description": "Resource 'PublicCloudConnector' create operation succeeded", "schema": { "$ref": "#/definitions/PublicCloudConnector" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_CreateOrUpdate - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_CreateOrUpdate_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "PublicCloudConnectors_Update", "tags": [ "PublicCloudConnectors" ], "description": "Update a PublicCloudConnector", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "publicCloudConnector", "in": "path", "description": "Represent public cloud connectors resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/PublicCloudConnectorUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PublicCloudConnector" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_Update - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_Update_MaximumSet_Gen.json" } } }, "delete": { "operationId": "PublicCloudConnectors_Delete", "tags": [ "PublicCloudConnectors" ], "description": "Delete a PublicCloudConnector", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "publicCloudConnector", "in": "path", "description": "Represent public cloud connectors resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_Delete - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_Delete_MaximumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}/testPermissions": { "post": { "operationId": "PublicCloudConnectors_TestPermissions", "tags": [ "PublicCloudConnectors" ], "description": "A long-running resource action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "publicCloudConnector", "in": "path", "description": "Represent public cloud connectors resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,63}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PublicCloudConnectors_TestPermissions - generated by [MaximumSet] rule": { "$ref": "./examples/PublicCloudConnectors_TestPermissions_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes": { "get": { "operationId": "SolutionTypes_ListByResourceGroup", "tags": [ "SolutionTypes" ], "description": "List SolutionTypeResource resources by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionTypeResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionTypes_ListByResourceGroup - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionTypes_ListByResourceGroup_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes/{solutionType}": { "get": { "operationId": "SolutionTypes_Get", "tags": [ "SolutionTypes" ], "description": "Get a SolutionTypeResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "solutionType", "in": "path", "description": "Solution Type resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SolutionTypeResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SolutionTypes_Get - generated by [MaximumSet] rule": { "$ref": "./examples/SolutionTypes_Get_MaximumSet_Gen.json" } } } } }, "definitions": { "AADProfileProperties": { "type": "object", "description": "The AAD Profile", "properties": { "serverId": { "type": "string", "description": "The arc ingress gateway server app id." }, "tenantId": { "type": "string", "description": "The target resource home tenant id." } }, "required": [ "serverId", "tenantId" ] }, "AwsCloudProfile": { "type": "object", "description": "cloud profile for AWS.", "properties": { "accountId": { "type": "string", "description": "Account id for the AWS account.", "x-ms-mutability": [ "read", "create" ] }, "excludedAccounts": { "type": "array", "description": "List of AWS accounts which need to be excluded.", "items": { "type": "string" } }, "isOrganizationalAccount": { "type": "boolean", "description": "Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account.", "default": false, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "accountId" ] }, "AwsCloudProfileUpdate": { "type": "object", "description": "cloud profile for AWS.", "properties": { "excludedAccounts": { "type": "array", "description": "List of AWS accounts which need to be excluded.", "items": { "type": "string" } } } }, "Azure.ResourceManager.ResourceProvisioningState": { "type": "string", "description": "The provisioning state of a resource type.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ResourceProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "CloudNativeType": { "type": "string", "description": "Cloud Native Type enum.", "enum": [ "ec2" ], "x-ms-enum": { "name": "CloudNativeType", "modelAsString": true, "values": [ { "name": "ec2", "value": "ec2", "description": "ec2 enum." } ] } }, "EndpointAccessResource": { "type": "object", "description": "The endpoint access for the target resource.", "properties": { "relay": { "$ref": "#/definitions/RelayNamespaceAccessProperties", "description": "Azure relay hybrid connection access properties", "x-ms-client-flatten": true } } }, "EndpointProperties": { "type": "object", "description": "Endpoint details", "properties": { "type": { "$ref": "#/definitions/Type", "description": "The type of endpoint." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource Id of the connectivity endpoint (optional)." }, "provisioningState": { "type": "string", "description": "The resource provisioning state.", "readOnly": true } }, "required": [ "type" ] }, "EndpointResource": { "type": "object", "description": "The endpoint for the target resource.", "properties": { "properties": { "$ref": "#/definitions/EndpointProperties", "description": "The endpoint properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "EndpointsList": { "type": "object", "description": "The list of endpoints.", "properties": { "value": { "type": "array", "description": "The list of endpoint.", "items": { "$ref": "#/definitions/EndpointResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link used to get the next page of endpoints list." } }, "required": [ "value" ] }, "GcpCloudProfile": { "type": "object", "description": "cloud profile for GCP.", "properties": { "projectProperties": { "$ref": "#/definitions/GcpProjectProperties", "description": "The project properties of the GCP project.", "x-ms-mutability": [ "read", "create" ] }, "organizationProperties": { "$ref": "#/definitions/GcpOrganizationProperties", "description": "The organization properties of the GCP organization.", "x-ms-mutability": [ "read", "create" ] } } }, "GcpCloudProfileUpdate": { "type": "object", "description": "cloud profile for GCP.", "properties": { "organizationProperties": { "$ref": "#/definitions/GcpOrganizationPropertiesUpdate", "description": "The organization properties of the GCP organization." } } }, "GcpOrganizationProperties": { "type": "object", "description": "GCP organization properties.", "properties": { "organizationId": { "type": "string", "description": "The organization id of the GCP organization.", "x-ms-mutability": [ "read", "create" ] }, "managementProjectNumber": { "type": "string", "description": "The project number of the management project under the GCP organization.", "x-ms-mutability": [ "read", "create" ] }, "managementProjectId": { "type": "string", "description": "The project Id of the management project under the GCP organization.", "x-ms-mutability": [ "read", "create" ] }, "excludedProjectNumbers": { "type": "array", "description": "List of GCP projects which need to be excluded.", "items": { "type": "string" }, "x-ms-mutability": [ "read", "create" ] }, "excludedFolderIds": { "type": "array", "description": "List of GCP folders which need to be excluded.", "items": { "type": "string" }, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "organizationId", "managementProjectNumber", "managementProjectId" ] }, "GcpOrganizationPropertiesUpdate": { "type": "object", "description": "GCP organization properties for update.", "properties": { "excludedProjectNumbers": { "type": "array", "description": "List of GCP projects which need to be excluded.", "items": { "type": "string" } }, "excludedFolderIds": { "type": "array", "description": "List of GCP folders which need to be excluded.", "items": { "type": "string" } } } }, "GcpProjectProperties": { "type": "object", "description": "GCP project properties.", "properties": { "projectNumber": { "type": "string", "description": "The project number of the GCP project.", "x-ms-mutability": [ "read", "create" ] }, "projectId": { "type": "string", "description": "The project id of the GCP project.", "x-ms-mutability": [ "read", "create" ] } }, "required": [ "projectNumber", "projectId" ] }, "GcpTemplateFormat": { "type": "string", "description": "GCP template format.", "enum": [ "terraform", "shellscript" ], "x-ms-enum": { "name": "GcpTemplateFormat", "modelAsString": true, "values": [ { "name": "Terraform", "value": "terraform", "description": "Terraform template format" }, { "name": "ShellScript", "value": "shellscript", "description": "Shell script template format" } ] } }, "GenerateAwsTemplateRequest": { "type": "object", "description": "ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template.", "properties": { "connectorId": { "type": "string", "description": "The name of public cloud connector" }, "solutionTypes": { "type": "array", "description": "The list of solution types and their settings", "items": { "$ref": "#/definitions/SolutionTypeSettings" }, "x-ms-identifiers": [] } }, "required": [ "connectorId" ] }, "GenerateAwsTemplateResponse": { "type": "object", "description": "The HybridConnectivity post operation response" }, "GenerateGcpTemplateRequest": { "type": "object", "description": "ConnectorId and SolutionTypes and their properties to Generate GCP Access Control Template.", "properties": { "connectorId": { "type": "string", "description": "The name of public cloud connector" }, "solutionTypes": { "type": "array", "description": "The list of solution types and their settings", "items": { "$ref": "#/definitions/SolutionTypeSettings" }, "x-ms-identifiers": [] }, "gcpCloudProfile": { "$ref": "#/definitions/GcpCloudProfile", "description": "The GCP cloud profile." }, "gcpTemplateFormat": { "$ref": "#/definitions/GcpTemplateFormat", "description": "Optional template output format. Defaults to 'terraform' if not provided" } }, "required": [ "connectorId" ] }, "GenerateGcpTemplateResponse": { "type": "object", "description": "The HybridConnectivity post operation response" }, "HostType": { "type": "string", "description": "Enum of host cloud the public cloud connector is referencing.", "enum": [ "AWS", "GCP" ], "x-ms-enum": { "name": "HostType", "modelAsString": true, "values": [ { "name": "AWS", "value": "AWS", "description": "AWS state" }, { "name": "GCP", "value": "GCP", "description": "GCP state" } ] } }, "IngressGatewayResource": { "type": "object", "description": "The ingress gateway access credentials", "properties": { "relay": { "$ref": "#/definitions/RelayNamespaceAccessProperties", "description": "Azure relay hybrid connection access properties", "x-ms-client-flatten": true }, "ingress": { "$ref": "#/definitions/IngressProfileProperties", "description": "Ingress gateway profile", "x-ms-client-flatten": true } } }, "IngressProfileProperties": { "type": "object", "description": "Ingress gateway profile", "properties": { "hostname": { "type": "string", "description": "The ingress hostname." }, "aadProfile": { "$ref": "#/definitions/AADProfileProperties", "description": "The AAD Profile", "x-ms-client-flatten": true } }, "required": [ "hostname", "aadProfile" ] }, "InventoryProperties": { "type": "object", "description": "Definition of inventory.", "properties": { "cloudNativeType": { "$ref": "#/definitions/CloudNativeType", "description": "Gets or sets the cloud native resource type." }, "cloudNativeResourceId": { "type": "string", "description": "Gets or sets the cloud native resource name." }, "azureResourceId": { "type": "string", "description": "Gets or sets the mapped azure resource id." }, "status": { "$ref": "#/definitions/SolutionConfigurationStatus", "description": "Gets or sets the status of the inventory." }, "statusDetails": { "type": "string", "description": "Gets or sets the status details." }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The resource provisioning state.", "readOnly": true } } }, "InventoryResource": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/InventoryProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "InventoryResourceListResult": { "type": "object", "description": "The response of a InventoryResource list operation.", "properties": { "value": { "type": "array", "description": "The InventoryResource items on this page", "items": { "$ref": "#/definitions/InventoryResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ListCredentialsRequest": { "type": "object", "description": "The details of the service for which credentials needs to be returned.", "properties": { "serviceName": { "$ref": "#/definitions/ServiceName", "description": "The name of the service. If not provided, the request will by pass the generation of service configuration token" } } }, "ListIngressGatewayCredentialsRequest": { "type": "object", "description": "Represent ListIngressGatewayCredentials Request object.", "properties": { "serviceName": { "$ref": "#/definitions/ServiceName", "description": "The name of the service. If not provided, the request will by pass the generation of service configuration token." } } }, "ManagedProxyRequest": { "type": "object", "description": "Represent ManageProxy Request object.", "properties": { "service": { "type": "string", "description": "The name of the service." }, "hostname": { "type": "string", "description": "The target host name." }, "serviceName": { "$ref": "#/definitions/ServiceName", "description": "The name of the service. It is an optional property, if not provided, service configuration tokens issue code would be by passed." } }, "required": [ "service" ] }, "ManagedProxyResource": { "type": "object", "description": "Managed Proxy", "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." } }, "required": [ "proxy", "expiresOn" ] }, "ProvisioningState": { "type": "string", "description": "The resource provisioning state.", "enum": [ "Succeeded", "Creating", "Updating", "Failed", "Canceled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded" }, { "name": "Creating", "value": "Creating" }, { "name": "Updating", "value": "Updating" }, { "name": "Failed", "value": "Failed" }, { "name": "Canceled", "value": "Canceled" } ] }, "readOnly": true }, "PublicCloudConnector": { "type": "object", "description": "Public Cloud Connector", "properties": { "properties": { "$ref": "#/definitions/PublicCloudConnectorProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true }, "kind": { "$ref": "#/definitions/HostType", "description": "The kind of the public cloud connector.", "readOnly": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "PublicCloudConnectorListResult": { "type": "object", "description": "The response of a PublicCloudConnector list operation.", "properties": { "value": { "type": "array", "description": "The PublicCloudConnector items on this page", "items": { "$ref": "#/definitions/PublicCloudConnector" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PublicCloudConnectorProperties": { "type": "object", "description": "Properties of public cloud connectors.", "properties": { "awsCloudProfile": { "$ref": "#/definitions/AwsCloudProfile", "description": "Cloud profile for AWS." }, "gcpCloudProfile": { "$ref": "#/definitions/GcpCloudProfile", "description": "Cloud profile for GCP." }, "hostType": { "$ref": "#/definitions/HostType", "description": "Host cloud the public cloud connector.", "x-ms-mutability": [ "read", "create" ] }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The resource provisioning state.", "readOnly": true }, "connectorPrimaryIdentifier": { "type": "string", "description": "Connector primary identifier.", "readOnly": true } }, "required": [ "hostType" ] }, "PublicCloudConnectorPropertiesUpdate": { "type": "object", "description": "Properties of public cloud connectors.", "properties": { "awsCloudProfile": { "$ref": "#/definitions/AwsCloudProfileUpdate", "description": "Cloud profile for AWS." }, "gcpCloudProfile": { "$ref": "#/definitions/GcpCloudProfileUpdate", "description": "Cloud profile for GCP." } } }, "PublicCloudConnectorUpdate": { "type": "object", "description": "Public Cloud Connector", "properties": { "properties": { "$ref": "#/definitions/PublicCloudConnectorPropertiesUpdate", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/TrackedResourceUpdate" } ] }, "RelayNamespaceAccessProperties": { "type": "object", "description": "Azure relay hybrid connection access properties", "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." } }, "required": [ "namespaceName", "namespaceNameSuffix", "hybridConnectionName" ] }, "ServiceConfigurationList": { "type": "object", "description": "The paginated list of serviceConfigurations", "properties": { "value": { "type": "array", "description": "The list of service configuration", "items": { "$ref": "#/definitions/ServiceConfigurationResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to fetch the next page of connected cluster" } }, "required": [ "value" ] }, "ServiceConfigurationProperties": { "type": "object", "description": "Service configuration details", "properties": { "serviceName": { "$ref": "#/definitions/ServiceName", "description": "Name of the service." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource Id of the connectivity endpoint (optional)." }, "port": { "type": "integer", "format": "int64", "description": "The port on which service is enabled." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The resource provisioning state.", "readOnly": true } }, "required": [ "serviceName" ] }, "ServiceConfigurationPropertiesPatch": { "type": "object", "description": "Service configuration details", "properties": { "port": { "type": "integer", "format": "int64", "description": "The port on which service is enabled." } } }, "ServiceConfigurationResource": { "type": "object", "description": "The service configuration details associated with the target resource.", "properties": { "properties": { "$ref": "#/definitions/ServiceConfigurationProperties", "description": "The service configuration properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ServiceConfigurationResourcePatch": { "type": "object", "description": "The service details under service configuration for the target endpoint resource.", "properties": { "properties": { "$ref": "#/definitions/ServiceConfigurationPropertiesPatch", "description": "The service configuration properties.", "x-ms-client-flatten": true } } }, "ServiceName": { "type": "string", "description": "Name of the service.", "enum": [ "SSH", "WAC" ], "x-ms-enum": { "name": "ServiceName", "modelAsString": true, "values": [ { "name": "SSH", "value": "SSH" }, { "name": "WAC", "value": "WAC" } ] } }, "SolutionConfiguration": { "type": "object", "description": "Solution Configuration", "properties": { "properties": { "$ref": "#/definitions/SolutionConfigurationProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SolutionConfigurationListResult": { "type": "object", "description": "The response of a SolutionConfiguration list operation.", "properties": { "value": { "type": "array", "description": "The SolutionConfiguration items on this page", "items": { "$ref": "#/definitions/SolutionConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SolutionConfigurationProperties": { "type": "object", "description": "Solution configuration resource.", "properties": { "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The resource provisioning state.", "readOnly": true }, "solutionType": { "type": "string", "description": "The type of the solution" }, "solutionSettings": { "$ref": "#/definitions/SolutionSettings", "description": "Solution settings" }, "status": { "$ref": "#/definitions/SolutionConfigurationStatus", "description": "The status of solution configurations", "readOnly": true }, "statusDetails": { "type": "string", "description": "The detailed message of status details", "readOnly": true }, "lastSyncTime": { "type": "string", "format": "date-time", "description": "The last time resources were inventoried", "readOnly": true } }, "required": [ "solutionType" ] }, "SolutionConfigurationPropertiesUpdate": { "type": "object", "description": "Solution configuration resource.", "properties": { "solutionType": { "type": "string", "description": "The type of the solution" }, "solutionSettings": { "$ref": "#/definitions/SolutionSettings", "description": "Solution settings" } } }, "SolutionConfigurationStatus": { "type": "string", "description": "Solution Configuration Status.", "enum": [ "New", "InProgress", "Completed", "Failed" ], "x-ms-enum": { "name": "SolutionConfigurationStatus", "modelAsString": true, "values": [ { "name": "New", "value": "New", "description": "New status" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress status" }, { "name": "Completed", "value": "Completed", "description": "Canceled status" }, { "name": "Failed", "value": "Failed", "description": "Failed status" } ] } }, "SolutionConfigurationUpdate": { "type": "object", "description": "Solution Configuration", "properties": { "properties": { "$ref": "#/definitions/SolutionConfigurationPropertiesUpdate", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SolutionSettings": { "type": "object", "description": "Solution settings", "additionalProperties": { "type": "string" } }, "SolutionTypeProperties": { "type": "object", "description": "Definition of Solution type resource.", "properties": { "solutionType": { "type": "string", "description": "The name of the solution type." }, "description": { "type": "string", "description": "Short description of solution type." }, "supportedAzureRegions": { "type": "array", "description": "The locations this solution is supported in.", "items": { "type": "string" } }, "hostTypes": { "type": "array", "description": "The supported host types for the current solution type.", "items": { "$ref": "#/definitions/HostType" } }, "solutionSettings": { "type": "array", "description": "Array of solution settings and its description.", "items": { "$ref": "#/definitions/SolutionTypeSettingsProperties" }, "x-ms-identifiers": [] } } }, "SolutionTypeResource": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/SolutionTypeProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SolutionTypeResourceListResult": { "type": "object", "description": "The response of a SolutionTypeResource list operation.", "properties": { "value": { "type": "array", "description": "The SolutionTypeResource items on this page", "items": { "$ref": "#/definitions/SolutionTypeResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SolutionTypeSettings": { "type": "object", "description": "The properties of Solution Type", "properties": { "solutionType": { "type": "string", "description": "The type of the solution" }, "solutionSettings": { "$ref": "#/definitions/SolutionSettings", "description": "Solution settings" } }, "required": [ "solutionType" ] }, "SolutionTypeSettingsProperties": { "type": "object", "description": "Represent Solution settings properties description array.", "properties": { "name": { "type": "string", "description": "The name of the solution setting property." }, "displayName": { "type": "string", "description": "The UI friendly name of the solution setting property." }, "type": { "type": "string", "description": "Type of the solution setting property, represented as a string." }, "description": { "type": "string", "description": "Description of solution setting property." }, "allowedValues": { "type": "array", "description": "Array of allowed values for this solution settings property.", "items": { "type": "string" } }, "hostTypes": { "type": "array", "description": "The supported host types for the current solution setting", "items": { "$ref": "#/definitions/HostType" } }, "defaultValue": { "type": "string", "description": "Default value for this solution settings property." } }, "required": [ "name", "displayName", "type", "description", "allowedValues", "hostTypes", "defaultValue" ] }, "TrackedResourceUpdate": { "type": "object", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "Type": { "type": "string", "description": "The type of endpoint.", "enum": [ "default", "custom" ], "x-ms-enum": { "name": "Type", "modelAsString": true, "values": [ { "name": "default", "value": "default" }, { "name": "custom", "value": "custom" } ] } } }, "parameters": { "Azure.ResourceManager.ResourceUriParameter": { "name": "resourceUri", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true } } }