Azure Event Grid Clients API

openapi: 3.2.0
info:
  version: '2025-02-15'
  title: EventGridManagementClient Clients API
  description: Azure EventGrid Management Client
servers:
- url: https://management.azure.com
tags:
- name: Clients
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients/{clientName}
  : get:
      tags:
      - Clients
      summary: Get a client
      description: Get properties of a client.
      operationId: Clients_Get
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: namespaceName
        in: path
        description: Name of the namespace.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 3
          pattern: ^[a-zA-Z0-9-]*$
      - name: clientName
        in: path
        description: Name of the client.
        required: true
        schema:
          type: string
          maxLength: 128
          minLength: 1
          pattern: ^[-a-zA-Z0-9:\._]*$
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        default:
          description: Error response returned if request was unsuccessful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
      - Clients
      summary: Create or update a client
      description: Create or update a client with the specified parameters.
      operationId: Clients_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: namespaceName
        in: path
        description: Name of the namespace.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 3
          pattern: ^[a-zA-Z0-9-]*$
      - name: clientName
        in: path
        description: The client name.
        required: true
        schema:
          type: string
          maxLength: 128
          minLength: 1
          pattern: ^[-a-zA-Z0-9:\._]*$
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Create or update request is successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        default:
          description: Error response returned if request was unsuccessful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Client'
        description: Client information.
        required: true
    delete:
      tags:
      - Clients
      summary: Delete a client
      description: Delete an existing client.
      operationId: Clients_Delete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: namespaceName
        in: path
        description: Name of the namespace.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 3
          pattern: ^[a-zA-Z0-9-]*$
      - name: clientName
        in: path
        description: Name of the client.
        required: true
        schema:
          type: string
          maxLength: 128
          minLength: 1
          pattern: ^[-a-zA-Z0-9:\._]*$
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
          headers:
            Location:
              schema:
                type: string
        '204':
          description: NoContent
        default:
          description: Error response returned if request was unsuccessful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clients
  : get:
      tags:
      - Clients
      summary: List all permission bindings under a namespace
      description: Get all the permission bindings under a namespace.
      operationId: Clients_ListByNamespace
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: The name of the resource group within the user's subscription.
        required: true
        schema:
          type: string
      - name: namespaceName
        in: path
        description: Name of the namespace.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 3
          pattern: ^[a-zA-Z0-9-]*$
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/FilterParameter'
      - $ref: '#/components/parameters/TopParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientsListResult'
        default:
          description: Error response returned if request was unsuccessful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
components:
  schemas:
    Resource:
      description: Definition of a Resource.
      type: object
      properties:
        id:
          description: Fully qualified identifier of the resource.
          type: string
          readOnly: true
        name:
          description: Name of the resource.
          type: string
          readOnly: true
        type:
          description: Type of the resource.
          type: string
          readOnly: true
      x-ms-azure-resource: true
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    ClientsListResult:
      description: Result of the List Client operation.
      type: object
      properties:
        value:
          description: A collection of Client.
          type: array
          items:
            $ref: '#/components/schemas/Client'
        nextLink:
          description: A link for the next page of Client.
          type: string
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    ClientProperties:
      description: The properties of client.
      type: object
      properties:
        description:
          description: Description for the Client resource.
          type: string
        authenticationName:
          description: The name presented by the client for authentication. The default value is the name of the resource.
          type: string
        clientCertificateAuthentication:
          $ref: '#/components/schemas/ClientCertificateAuthentication'
          description: The client certificate authentication information.
        state:
          description: Indicates if the client is enabled or not. Default value is Enabled.
          default: Enabled
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: ClientState
            modelAsString: true
        attributes:
          description: 'Attributes for the client. Supported values are int, bool, string, string[].

            Example:

            "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }'
          type: object
          additionalProperties: {}
        provisioningState:
          description: Provisioning state of the Client resource.
          enum:
          - Creating
          - Updating
          - Deleting
          - Succeeded
          - Canceled
          - Failed
          - Deleted
          type: string
          readOnly: true
          x-ms-enum:
            name: ClientProvisioningState
            modelAsString: true
    Client:
      description: The Client resource.
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
      properties:
        properties:
          $ref: '#/components/schemas/ClientProperties'
          description: The properties of client.
          x-ms-client-flatten: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: The system metadata relating to the Event Grid resource.
          type: object
          readOnly: true
    ClientCertificateAuthentication:
      description: The certificate authentication properties for the client.
      type: object
      properties:
        validationScheme:
          description: The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName.
          enum:
          - SubjectMatchesAuthenticationName
          - DnsMatchesAuthenticationName
          - UriMatchesAuthenticationName
          - IpMatchesAuthenticationName
          - EmailMatchesAuthenticationName
          - ThumbprintMatch
          type: string
          x-ms-enum:
            name: ClientCertificateValidationScheme
            modelAsString: true
        allowedThumbprints:
          description: The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'.
          type: array
          items:
            type: string
  parameters:
    FilterParameter:
      name: $filter
      in: query
      description: 'The query used to filter the search results using OData syntax. Filtering is permitted on the ''name'' property only and with limited number of OData operations. These operations are: the ''contains'' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, ''PATTERN'') and name ne ''PATTERN-1''. The following is not a valid filter example: $filter=location eq ''westus''.'
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of the API to be used with the client request.
      required: true
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      required: true
      schema:
        type: string
    TopParameter:
      name: $top
      in: query
      description: The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow