Microsoft Azure Active Directory

Microsoft Azure Active Directory is a cloud-based directory service that provides a secure and seamless way for users to access their applications and devices. It allows organizations to centrally manage and secure user identities and control access to resources within their environment.

OpenAPI Specification

azureactivedirectory-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  version: 2020-03-01-preview
  title: Microsoft Azure azureactivedirectory
  description: Azure Active Directory Client.
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.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources
  : get:
      tags:
        - PrivateLinkResources
      description: >-
        Gets the private link resources that need to be created for a policy of
        AzureAD.
      operationId: microsoftAzurePrivatelinkresourcesListbyprivatelinkpolicy
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/policyNameParameter'
        - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved private link resources.
          schema:
            $ref: '#/definitions/PrivateLinkResourceListResult'
      x-ms-examples:
        Gets private endpoint connection.:
          $ref: ./examples/AzureADPrivateLinkResourceListGet.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Aadiam Privatelinkforazuread Policyname Privatelinkresources
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/privateLinkResources/{groupName}
  : get:
      tags:
        - PrivateLinkResources
      description: >-
        Gets the private link resources that need to be created for a policy of
        AzureAD.
      operationId: microsoftAzurePrivatelinkresourcesGet
      parameters:
        - $ref: '#/parameters/subscriptionIdParameter'
        - $ref: '#/parameters/resourceGroupNameParameter'
        - $ref: '#/parameters/policyNameParameter'
        - $ref: '#/parameters/groupNameParameter'
        - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved a specified private link resource.
          schema:
            $ref: '#/definitions/PrivateLinkResource'
      x-ms-examples:
        Gets private endpoint connection.:
          $ref: ./examples/AzureADPrivateLinkResourceGet.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Aadiam Privatelinkforazuread Policyname Privatelinkresources Groupname
definitions:
  PrivateLinkResourceListResult:
    description: A list of private link resources
    type: object
    properties:
      value:
        type: array
        description: Array of private link resources
        items:
          $ref: '#/definitions/PrivateLinkResource'
      nextLink:
        description: The link used to get the next page of operations.
        type: string
  PrivateLinkResource:
    description: A private link resource
    type: object
    properties:
      properties:
        $ref: '#/definitions/PrivateLinkResourceProperties'
        description: Resource properties.
        x-ms-client-flatten: true
    allOf:
      - $ref: '#/definitions/ARMProxyResource'
  PrivateLinkResourceProperties:
    description: Properties of a private link resource.
    type: object
    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
  ARMProxyResource:
    type: object
    description: >-
      The resource model definition for a ARM proxy resource. It will have
      everything other than required location and tags
    properties:
      id:
        readOnly: true
        type: string
        description: The unique resource identifier of the Azure AD PrivateLink Policy.
      name:
        readOnly: true
        type: string
        description: The name of the Azure AD PrivateLink Policy.
      type:
        readOnly: true
        type: string
        description: The type of Azure resource.
    x-ms-azure-resource: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure subscription ID.
    required: true
    type: string
    x-ms-parameter-location: client
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request.
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
    description: Name of an Azure resource group.
  groupNameParameter:
    name: groupName
    in: path
    description: The name of the private link resource.
    required: true
    x-ms-parameter-location: method
    type: string
  policyNameParameter:
    name: policyName
    in: path
    required: true
    type: string
    description: The name of the private link policy in Azure AD.
    x-ms-parameter-location: method
tags:
  - name: PrivateLinkResources