Skip to content

Commit

Permalink
[DataFactory] Add privateEndpointConnection apis (#13249)
Browse files Browse the repository at this point in the history 
* [DataFactory] Add privateEndpointConnection apis

* resolve some style errors

* resolve

* resolve 1

* commit

* resolve 1 comment
@Jingshu923
Jingshu923 authored Mar 19, 2021
1 parent 9cd6e37 commit 08c5078
Showing 6 changed files with 563 additions and 0 deletions.
409 changes: 409 additions & 0 deletions ...ion/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json
View file
Original file line number Diff line number Diff line change
@@ -4079,6 +4079,246 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndPointConnections": {
"get": {
"tags": [
"privateEndPointConnections"
],
"operationId": "privateEndPointConnections_ListByFactory",
"x-ms-examples": {
"privateEndPointConnections_ListByFactory": {
"$ref": "./examples/PrivateEndPointConnections_ListByFactory.json"
}
},
"description": "Lists Private endpoint connections",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionListResponse"
}
},
"default": {
"description": "An error response received from the Azure Data Factory service.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateEndpointConnections/{privateEndpointConnectionName}": {
"put": {
"tags": [
"privateEndpointConnections"
],
"description": "Approves or rejects a private endpoint connection",
"operationId": "PrivateEndpointConnection_CreateOrUpdate",
"x-ms-examples": {
"Approves or rejects a private endpoint connection for a factory.": {
"$ref": "./examples/ApproveRejectPrivateEndpointConnection.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/privateEndpointConnectionName"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "If-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
},
{
"name": "privateEndpointWrapper",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateLinkConnectionApprovalRequestResource"
}
}
],
"responses": {
"200": {
"description": "OK.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionResource"
}
},
"default": {
"description": "An error response received from PUT privateEndpointConnections operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"get": {
"tags": [
"privateEndpointConnections"
],
"description": "Gets a private endpoint connection",
"operationId": "PrivateEndpointConnection_Get",
"x-ms-examples": {
"Get a private endpoint connection for a datafactory.": {
"$ref": "./examples/GetPrivateEndpointConnection.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/privateEndpointConnectionName"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "If-None-Match",
"in": "header",
"required": false,
"type": "string",
"description": "ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionResource"
}
},
"default": {
"description": "An error response received from GET privateEndpointConnections operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"delete": {
"tags": [
"privateEndpointConnections"
],
"description": "Deletes a private endpoint connection",
"operationId": "PrivateEndpointConnection_Delete",
"x-ms-examples": {
"Delete a private endpoint connection for a datafactory.": {
"$ref": "./examples/DeletePrivateEndpointConnection.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/privateEndpointConnectionName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "OK."
},
"204": {
"description": "No content."
},
"default": {
"description": "An error response received from DELETE privateEndpointConnections operation.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/privateLinkResources": {
"get": {
"tags": [
"privateLinkResources"
],
"description": "Gets the private link resources",
"operationId": "privateLinkResources_Get",
"x-ms-examples": {
"Get private link resources of a site": {
"$ref": "./examples/GetPrivateLinkResources.json"
}
},
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PrivateLinkResourcesWrapper"
}
},
"default": {
"description": "App Service error response.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
@@ -6467,6 +6707,167 @@
"required": [
"properties"
]
},
"PrivateEndpointConnectionListResponse": {
"description": "A list of linked service resources.",
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"description": "List of Private Endpoint Connections.",
"items": {
"$ref": "#/definitions/PrivateEndpointConnectionResource"
}
},
"nextLink": {
"description": "The link to the next page of results, if any remaining results exist.",
"type": "string"
}
}
},
"PrivateEndpointConnectionResource": {
"description": "Private Endpoint Connection ARM resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SubResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/RemotePrivateEndpointConnection",
"description": "Core resource properties"
}
}
},
"RemotePrivateEndpointConnection": {
"description": "A remote private endpoint connection",
"type": "object",
"properties": {
"provisioningState": {
"type": "string",
"readOnly": true
},
"privateEndpoint": {
"$ref": "#/definitions/ArmIdWrapper",
"description": "PrivateEndpoint of a remote private endpoint connection"
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkConnectionState"
}
}
},
"ArmIdWrapper": {
"description": "A wrapper for an ARM resource id",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
}
}
},
"PrivateLinkConnectionState": {
"description": "The state of a private link connection",
"type": "object",
"properties": {
"status": {
"description": "Status of a private link connection",
"type": "string"
},
"description": {
"description": "Description of a private link connection",
"type": "string"
},
"actionsRequired": {
"description": "ActionsRequired for a private link connection",
"type": "string"
}
}
},
"PrivateLinkConnectionApprovalRequestResource": {
"description": "Private Endpoint Connection Approval ARM resource.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SubResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkConnectionApprovalRequest",
"description": "Core resource properties"
}
}
},
"PrivateLinkConnectionApprovalRequest": {
"description": "A request to approve or reject a private endpoint connection",
"type": "object",
"properties": {
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkConnectionState"
}
}
},
"PrivateLinkResourcesWrapper": {
"description": "Wrapper for a collection of private link resources",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
}
}
},
"PrivateLinkResource": {
"description": "A private link resource",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SubResource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Core resource properties"
}
}
},
"PrivateLinkResourceProperties": {
"description": "Properties of a private link resource",
"type": "object",
"properties": {
"groupId": {
"description": "GroupId of a private link resource",
"type": "string",
"readOnly": true
},
"requiredMembers": {
"description": "RequiredMembers of a private link resource",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"requiredZoneNames": {
"description": "RequiredZoneNames of a private link resource",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
},
"parameters": {
@@ -6620,6 +7021,14 @@
"in": "query",
"required": true,
"type": "string"
},
"privateEndpointConnectionName": {
"name": "privateEndpointConnectionName",
"description": "The private endpoint connection name.",
"in": "path",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}
40 changes: 40 additions & 0 deletions ...rosoft.DataFactory/stable/2018-06-01/examples/ApproveRejectPrivateEndpointConnection.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"privateEndpointConnectionName": "connection",
"api-version": "2018-06-01",
"ifMatch": null,
"privateEndpointWrapper": {
"properties": {
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
},
"responses": {
"200": {
"headers": {},
"body": {
"name": "exampleFactoryName",
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
"type": "Microsoft.DataFactory/factories/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
}
}
}
13 changes: 13 additions & 0 deletions ...ger/Microsoft.DataFactory/stable/2018-06-01/examples/DeletePrivateEndpointConnection.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"privateEndpointConnectionName": "connection",
"api-version": "2018-06-01"
},
"responses": {
"200": {},
"204": {}
}
}
31 changes: 31 additions & 0 deletions ...anager/Microsoft.DataFactory/stable/2018-06-01/examples/GetPrivateEndpointConnection.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"privateEndpointConnectionName": "connection",
"api-version": "2018-06-01",
"ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000"
},
"responses": {
"200": {
"headers": {},
"body": {
"name": "exampleFactoryName",
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
"type": "Microsoft.DataFactory/factories/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": ""
}
}
}
}
}
}
31 changes: 31 additions & 0 deletions ...rce-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GetPrivateLinkResources.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"name": "exampleFactoryName",
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
"type": "Microsoft.DataFactory/factories/privateLinkResources",
"properties": {
"groupId": "dataFactory",
"requiredMembers": [
"dataFactory"
],
"requiredZoneNames": [
"privatelink.datafactory.azure.net"
]
}
}
]
}
}
}
}
39 changes: 39 additions & 0 deletions ...soft.DataFactory/stable/2018-06-01/examples/PrivateEndPointConnections_ListByFactory.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {
"Date": "Wed, 13 Jun 2020 21:33:05 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "14908",
"x-ms-request-id": "9e6639e9-bece-4c0c-85de-4cadc30a73a6",
"x-ms-correlation-request-id": "9e6639e9-bece-4c0c-85de-4cadc30a73a6"
},
"body": {
"value": [
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/privateEndpoints/myPrivateEndpoint",
"name": "factories",
"type": "Microsoft.DataFactory/factories/privateEndpointConnections",
"properties": {
"provisioningState": "Succeeded",
"privateEndpoint": {
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/managedVirtualNetworks/myPrivateEndpoint"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Approved by admin.",
"actionsRequired": "exampleActionsRequired"
}
}
}
]
}
}
}
}

0 comments on commit 08c5078

Please sign in to comment.