Microsoft Azure

Microsoft Azure Relay API

Microsoft Azure Relay API provides a secure way to establish communication between on-premises and cloud-based applications, enabling seamless data exchange and interaction between different environments. By acting as a bridge between the two, the Azure Relay API allows for real-time messaging and event-driven scenarios, making it easier for organizations to integrate their systems and services.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/relay/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/relay-api-openapi-original.yml

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure Relay API
  description: >-
    Use these API to manage Azure Relay resources through Azure Resource
    Manager.
  version: 2018-01-01-preview
  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}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/privateLinkResources
  : get:
      tags:
        - PrivateLinkResources
      operationId: microsoftAzurePrivatelinkresourcesget
      x-ms-examples:
        RelayPrivateLinkResourcesList:
          $ref: ./examples/PrivateEndpointConnections/ListPrivateLinkResources.json
      description: Gets the private link resources supported for the Relay 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: Successfully retrieved private link resources.
          schema:
            $ref: '#/definitions/PrivateLinkResourceListResult'
        default:
          description: Relay error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Relay Namespaces Namespacename Privatelinkresources
definitions:
  PrivateLinkResourceListResult:
    properties:
      value:
        type: array
        description: Array of private link resources
        items:
          $ref: '#/definitions/PrivateLinkResource'
    description: A list of private link resources
  PrivateLinkResource:
    properties:
      properties:
        $ref: '#/definitions/PrivateLinkResourceProperties'
        description: Resource properties.
        x-ms-client-flatten: true
    allOf:
      - $ref: ../../common/v1/definitions.json#/definitions/Resource
    description: A private link resource
  PrivateLinkResourceProperties:
    properties:
      groupId:
        description: Group identifier of private link resource.
        type: string
        readOnly: true
      requiredMembers:
        description: Required member names of private link resource.
        type: array
        items:
          type: string
        readOnly: true
      requiredZoneNames:
        type: array
        items:
          type: string
        description: Required DNS zone names of the the private link resource.
    description: Properties of a private link resource.
parameters: {}
tags:
  - name: PrivateLinkResources