{ "swagger": "2.0", "info": { "title": "Relay API", "description": "Use these API to manage Azure Relay resources through Azure Resource Manager.", "version": "2021-11-01", "x-ms-code-generation-settings": { "name": "RelayManagementClient" } }, "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": { "/subscriptions/{subscriptionId}/providers/Microsoft.Relay/checkNameAvailability": { "post": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CheckNameAvailability", "x-ms-examples": { "RelayCheckNameAvailability": { "$ref": "./examples/NameSpaces/RelayNameSpaceCheckNameAvailability.json" } }, "description": "Check the specified namespace name availability.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckNameAvailability" }, "description": "Parameters to check availability of the specified namespace name." } ], "responses": { "200": { "description": "Check availability returned successfully.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Relay/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_List", "x-ms-examples": { "RelayNameSpaceListBySubscription": { "$ref": "./examples/NameSpaces/RelayNameSpaceListBySubscription.json" } }, "description": "Lists all the available namespaces within the subscription regardless of the resourceGroups.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces returned successfully", "schema": { "$ref": "#/definitions/RelayNamespaceListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces": { "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_ListByResourceGroup", "x-ms-examples": { "RelayNameSpaceListByResourceGroup": { "$ref": "./examples/NameSpaces/RelayNameSpaceListByResourceGroup.json" } }, "description": "Lists all the available namespaces within the ResourceGroup.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespaces by resource group returned successfully", "schema": { "$ref": "#/definitions/RelayNamespaceListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}": { "put": { "tags": [ "Namespaces" ], "operationId": "Namespaces_CreateOrUpdate", "x-ms-examples": { "RelayNamespaceCreate": { "$ref": "./examples/NameSpaces/RelayNameSpaceCreate.json" } }, "description": "Create Azure Relay namespace.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RelayNamespace" }, "description": "Parameters supplied to create a namespace resource." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace create request succeeded.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "201": { "description": "Namespace create request accepted.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Delete", "x-ms-examples": { "RelayNameSpaceDelete": { "$ref": "./examples/NameSpaces/RelayNameSpaceDelete.json" } }, "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace delete request succeeded." }, "202": { "description": "Namespace delete request has been accepted for processing and the operation will complete asynchronously." }, "204": { "description": "Namespace delete request has been accepted, but the namespace was not found." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Get", "x-ms-examples": { "RelayNameSpaceGet": { "$ref": "./examples/NameSpaces/RelayNameSpaceGet.json" } }, "description": "Returns the description for the specified namespace.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace description returned successfully.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "patch": { "tags": [ "Namespaces" ], "operationId": "Namespaces_Update", "x-ms-examples": { "RelayNameSpaceUpdate": { "$ref": "./examples/NameSpaces/RelayNameSpaceUpdate.json" } }, "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RelayUpdateParameters" }, "description": "Parameters for updating a namespace resource." }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "201": { "description": "Namespace update request accepted.", "schema": { "$ref": "#/definitions/RelayNamespace" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections": { "get": { "tags": [ "Namespaces PrivateEndpointConnections" ], "operationId": "PrivateEndpointConnections_List", "x-ms-examples": { "PrivateEndpointConnectionsList": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnectionsList.json" } }, "description": "Gets the available PrivateEndpointConnections within a namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "PrivateEndpointConnections successfully returned.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "RelayRelay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { "put": { "tags": [ "Namespaces PrivateEndpointConnections" ], "operationId": "PrivateEndpointConnections_CreateOrUpdate", "x-ms-examples": { "NameSpacePrivateEndPointConnectionCreate": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnectionsCreate.json" } }, "description": "Creates or updates PrivateEndpointConnections of service namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" }, "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." } ], "responses": { "200": { "description": "Status of PrivateEndPoint Connection Created successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Request to update Status of PrivateEndPoint Connection accepted.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "Request to update Status of PrivateEndPoint Connection accepted.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "Namespaces PrivateEndpointConnections" ], "operationId": "PrivateEndpointConnections_Delete", "x-ms-examples": { "NameSpacePrivateEndPointConnectionDelete": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnectionsDelete.json" } }, "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" } ], "responses": { "200": { "description": "Private Endpoint Connection successfully deleted." }, "202": { "description": "Private Endpoint Connection delete request accepted." }, "204": { "description": "No content." }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "Namespaces PrivateEndpointConnections" ], "operationId": "PrivateEndpointConnections_Get", "x-ms-examples": { "NameSpacePrivateEndPointConnectionGet": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnectionsGet.json" } }, "description": "Gets a description for the specified Private Endpoint Connection name.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Private Endpoint Connection successfully returned.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources/{privateLinkResourceName}": { "get": { "tags": [ "Namespaces PrivateLinkResources" ], "operationId": "PrivateLinkResources_Get", "x-ms-examples": { "NameSpacePrivateEndPointConnectionGet": { "$ref": "./examples/PrivateEndpointConnections/PrivateLinkResourcesGet.json" } }, "description": "Gets a description for the specified Private Endpoint Connection name.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/PrivateLinkResourceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Private Endpoint Connection successfully returned.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources": { "get": { "tags": [ "Namespaces PrivateLinkResources" ], "operationId": "PrivateLinkResources_List", "x-ms-examples": { "NameSpacePrivateLinkResourcesGet": { "$ref": "./examples/PrivateEndpointConnections/PrivateLinkResourcesList.json" } }, "description": "Gets lists of resources that supports Privatelinks.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" }, "parameters": [ { "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Private Link resource List", "schema": { "$ref": "#/definitions/PrivateLinkResourcesListResult" } }, "default": { "description": "Relay error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } } }, "definitions": { "ResourceNamespacePatch": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Definition of resource." }, "RelayNamespaceListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/RelayNamespace" }, "description": "Result of the list namespace operation." }, "nextLink": { "type": "string", "description": "Link to the next set of results. Not empty if value contains incomplete list of namespaces." } }, "description": "The response from the list namespace operation." }, "RelayNamespace": { "type": "object", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "SKU of the namespace." }, "systemData": { "readOnly": true, "description": "The system meta data relating to this resource.", "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RelayNamespaceProperties", "description": "Description of Relay namespace" } }, "description": "Description of a namespace resource.", "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" } ] }, "RelayNamespaceProperties": { "type": "object", "properties": { "provisioningState": { "readOnly": true, "type": "string", "description": "Provisioning state of the Namespace." }, "status": { "readOnly": true, "type": "string", "description": "Status of the Namespace." }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "The time the namespace was created." }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "The time the namespace was updated." }, "serviceBusEndpoint": { "type": "string", "readOnly": true, "description": "Endpoint you can use to perform Service Bus operations." }, "metricId": { "type": "string", "readOnly": true, "description": "Identifier for Azure Insights metrics." }, "privateEndpointConnections": { "description": "List of private endpoint connections.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "publicNetworkAccess": { "description": "This determines if traffic is allowed over public network. By default it is enabled.", "enum": [ "Enabled", "Disabled", "SecuredByPerimeter" ], "type": "string", "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true }, "default": "Enabled" } }, "description": "Properties of the namespace." }, "RelayUpdateParameters": { "type": "object", "properties": { "sku": { "$ref": "#/definitions/Sku", "description": "SKU of the namespace." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RelayNamespaceProperties", "description": "Description of Relay namespace." } }, "description": "Description of a namespace resource.", "allOf": [ { "$ref": "#/definitions/ResourceNamespacePatch" } ] }, "Sku": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of this SKU.", "enum": [ "Standard" ], "x-ms-enum": { "name": "SkuName", "modelAsString": true } }, "tier": { "type": "string", "description": "The tier of this SKU.", "enum": [ "Standard" ], "x-ms-enum": { "name": "SkuTier", "modelAsString": true } } }, "description": "SKU of the namespace.", "required": [ "name" ] }, "UnavailableReason": { "type": "string", "enum": [ "None", "InvalidName", "SubscriptionIsDisabled", "NameInUse", "NameInLockdown", "TooManyNamespaceInCurrentSubscription" ], "x-ms-enum": { "name": "UnavailableReason", "modelAsString": true }, "description": "Specifies the reason for the unavailability of the service." }, "CheckNameAvailability": { "type": "object", "properties": { "name": { "type": "string", "description": "The namespace name to check for availability. The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." } }, "required": [ "name" ], "description": "Description of the check name availability request properties." }, "CheckNameAvailabilityResult": { "type": "object", "properties": { "message": { "type": "string", "readOnly": true, "description": "The detailed info regarding the reason associated with the namespace." }, "nameAvailable": { "type": "boolean", "description": "Value indicating namespace is available. Returns true if the namespace is available; otherwise, false." }, "reason": { "$ref": "#/definitions/UnavailableReason", "description": "The reason for unavailability of a namespace." } }, "description": "Description of the check name availability request properties." }, "PrivateEndpointConnection": { "type": "object", "description": "Properties of the PrivateEndpointConnection.", "allOf": [ { "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Properties of the PrivateEndpointConnection.", "x-ms-client-flatten": true }, "systemData": { "readOnly": true, "description": "The system meta data relating to this resource.", "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" } } }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of the private endpoint connection resource.", "properties": { "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The Private Endpoint resource for this Connection." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/ConnectionState", "description": "Details about the state of the connection." }, "provisioningState": { "description": "Provisioning state of the Private Endpoint Connection.", "enum": [ "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed" ], "type": "string", "x-ms-enum": { "name": "EndPointProvisioningState", "modelAsString": true } } } }, "PrivateEndpoint": { "type": "object", "description": "PrivateEndpoint information.", "properties": { "id": { "description": "The ARM identifier for Private Endpoint.", "type": "string" } } }, "ConnectionState": { "type": "object", "description": "ConnectionState information.", "properties": { "status": { "description": "Status of the connection.", "enum": [ "Pending", "Approved", "Rejected", "Disconnected" ], "type": "string", "x-ms-enum": { "name": "PrivateLinkConnectionStatus", "modelAsString": true } }, "description": { "description": "Description of the connection state.", "type": "string" } } }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "Result of the list of all private endpoint connections operation.", "properties": { "value": { "description": "A collection of private endpoint connection resources.", "type": "array", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "description": "A link for the next page of private endpoint connection resources.", "type": "string" } } }, "PrivateLinkResource": { "type": "object", "description": "Information of the private link resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Properties of the private link resource.", "x-ms-client-flatten": true }, "id": { "description": "Fully qualified identifier of the resource.", "type": "string" }, "name": { "description": "Name of the resource", "type": "string" }, "type": { "description": "Type of the resource", "type": "string" } } }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of PrivateLinkResource", "properties": { "groupId": { "description": "The private link resource group id.", "type": "string" }, "requiredMembers": { "type": "array", "description": "The private link resource required member names.", "items": { "type": "string" } }, "requiredZoneNames": { "type": "array", "description": "The private link resource Private link DNS zone name.", "items": { "type": "string" } } } }, "PrivateLinkResourcesListResult": { "type": "object", "description": "Result of the List private link resources operation.", "properties": { "value": { "description": "A collection of private link resources", "type": "array", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "description": "A link for the next page of private link resources.", "type": "string" } } } }, "parameters": {} }