Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 174 additions & 0 deletions specification/common-types/resource-management/v2/privatelinks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
{
"swagger": "2.0",
"info": {
"version": "2.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use v2? as it may cause avocado validation failure

"title": "Common types"
},
"paths": {},
"definitions": {
"PrivateEndpoint": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "The ARM identifier for Private Endpoint"
}
},
"description": "The Private Endpoint resource."
},
"PrivateEndpointConnection": {
"properties": {
"properties": {
"$ref": "#/definitions/PrivateEndpointConnectionProperties",
"x-ms-client-flatten": true,
"description": "Resource properties."
}
},
"allOf": [
{
"$ref": "./types.json#/definitions/Resource"
}
],
"description": "The Private Endpoint Connection resource."
},
"PrivateEndpointConnectionProperties": {
"properties": {
"privateEndpoint": {
"$ref": "#/definitions/PrivateEndpoint",
"description": "The resource of private end point."
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkServiceConnectionState",
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"provisioningState": {
"$ref": "#/definitions/PrivateEndpointConnectionProvisioningState",
"description": "The provisioning state of the private endpoint connection resource."
}
},
"required": [
"privateLinkServiceConnectionState"
],
"description": "Properties of the PrivateEndpointConnectProperties."
},
"PrivateLinkServiceConnectionState": {
"properties": {
"status": {
"$ref": "#/definitions/PrivateEndpointServiceConnectionStatus",
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service."
},
"description": {
"type": "string",
"description": "The reason for approval/rejection of the connection."
},
"actionsRequired": {
"type": "string",
"description": "A message indicating if changes on the service provider require any updates on the consumer."
}
},
"description": "A collection of information about the state of the connection between service consumer and provider."
},
"PrivateEndpointServiceConnectionStatus": {
"type": "string",
"description": "The private endpoint connection status.",
"enum": [
"Pending",
"Approved",
"Rejected"
],
"x-ms-enum": {
"name": "PrivateEndpointServiceConnectionStatus",
"modelAsString": true
}
},
"PrivateEndpointConnectionProvisioningState": {
"type": "string",
"readOnly": true,
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Failed"
],
"x-ms-enum": {
"name": "PrivateEndpointConnectionProvisioningState",
"modelAsString": true
}
},
"PrivateLinkResource": {
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "./types.json#/definitions/Resource"
}
],
"description": "A private link resource"
},
"PrivateLinkResourceProperties": {
"properties": {
"groupId": {
"description": "The private link resource group id.",
"type": "string",
"readOnly": true
},
"requiredMembers": {
"description": "The private link resource required member names.",
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"requiredZoneNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The private link resource Private link DNS zone name."
}
},
"description": "Properties of a private link resource."
},
"PrivateEndpointConnectionListResult": {
"properties": {
"value": {
"type": "array",
"description": "Array of private endpoint connections",
"items": {
"$ref": "#/definitions/PrivateEndpointConnection"
}
}
},
"description": "List of private endpoint connection associated with the specified storage account"
},
"PrivateLinkResourceListResult": {
"properties": {
"value": {
"type": "array",
"description": "Array of private link resources",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
}
},
"description": "A list of private link resources"
}
},
"parameters": {
"PrivateEndpointConnectionName": {
"name": "privateEndpointConnectionName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the private endpoint connection associated with the Azure resource",
"x-ms-parameter-location": "method"
}
}
}