SystemTopicEventSubscriptions.yml

### YamlMime:TSType
name: SystemTopicEventSubscriptions
uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions'
package: '@azure/arm-eventgrid'
summary: Interface representing a SystemTopicEventSubscriptions.
fullName: SystemTopicEventSubscriptions
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginCreateOrUpdate(string, string, string, EventSubscription,
      SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.beginCreateOrUpdate'
    package: '@azure/arm-eventgrid'
    summary: >-
      Asynchronously creates or updates an event subscription with the specified
      parameters. Existing

      event subscriptions will be updated with this API.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdate(resourceGroupName: string, systemTopicName:
        string, eventSubscriptionName: string, eventSubscriptionInfo:
        EventSubscription, options?:
        SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams):
        Promise<PollerLike<PollOperationState<EventSubscription>,
        EventSubscription>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: eventSubscriptionInfo
          type: <xref uid="@azure/arm-eventgrid.EventSubscription" />
          description: |-
            Event subscription properties containing the destination and filter
                                         information.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-eventgrid.EventSubscription" />&gt;, <xref
          uid="@azure/arm-eventgrid.EventSubscription" />&gt;&gt;
  - name: >-
      beginCreateOrUpdateAndWait(string, string, string, EventSubscription,
      SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams)
    uid: >-
      @azure/arm-eventgrid.SystemTopicEventSubscriptions.beginCreateOrUpdateAndWait
    package: '@azure/arm-eventgrid'
    summary: >-
      Asynchronously creates or updates an event subscription with the specified
      parameters. Existing

      event subscriptions will be updated with this API.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdateAndWait(resourceGroupName: string,
        systemTopicName: string, eventSubscriptionName: string,
        eventSubscriptionInfo: EventSubscription, options?:
        SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams):
        Promise<EventSubscription>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: eventSubscriptionInfo
          type: <xref uid="@azure/arm-eventgrid.EventSubscription" />
          description: |-
            Event subscription properties containing the destination and filter
                                         information.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-eventgrid.EventSubscription" />&gt;
  - name: >-
      beginDelete(string, string, string,
      SystemTopicEventSubscriptionsDeleteOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.beginDelete'
    package: '@azure/arm-eventgrid'
    summary: Delete an existing event subscription of a system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDelete(resourceGroupName: string, systemTopicName: string,
        eventSubscriptionName: string, options?:
        SystemTopicEventSubscriptionsDeleteOptionalParams):
        Promise<PollerLike<PollOperationState<void>, void>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;void&gt;, void&gt;&gt;
  - name: >-
      beginDeleteAndWait(string, string, string,
      SystemTopicEventSubscriptionsDeleteOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.beginDeleteAndWait'
    package: '@azure/arm-eventgrid'
    summary: Delete an existing event subscription of a system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDeleteAndWait(resourceGroupName: string, systemTopicName:
        string, eventSubscriptionName: string, options?:
        SystemTopicEventSubscriptionsDeleteOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      beginUpdate(string, string, string, EventSubscriptionUpdateParameters,
      SystemTopicEventSubscriptionsUpdateOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.beginUpdate'
    package: '@azure/arm-eventgrid'
    summary: Update an existing event subscription of a system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdate(resourceGroupName: string, systemTopicName: string,
        eventSubscriptionName: string, eventSubscriptionUpdateParameters:
        EventSubscriptionUpdateParameters, options?:
        SystemTopicEventSubscriptionsUpdateOptionalParams):
        Promise<PollerLike<PollOperationState<EventSubscription>,
        EventSubscription>>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: eventSubscriptionUpdateParameters
          type: >-
            <xref uid="@azure/arm-eventgrid.EventSubscriptionUpdateParameters"
            />
          description: Updated event subscription information.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-eventgrid.EventSubscription" />&gt;, <xref
          uid="@azure/arm-eventgrid.EventSubscription" />&gt;&gt;
  - name: >-
      beginUpdateAndWait(string, string, string,
      EventSubscriptionUpdateParameters,
      SystemTopicEventSubscriptionsUpdateOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.beginUpdateAndWait'
    package: '@azure/arm-eventgrid'
    summary: Update an existing event subscription of a system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdateAndWait(resourceGroupName: string, systemTopicName:
        string, eventSubscriptionName: string,
        eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters,
        options?: SystemTopicEventSubscriptionsUpdateOptionalParams):
        Promise<EventSubscription>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: eventSubscriptionUpdateParameters
          type: >-
            <xref uid="@azure/arm-eventgrid.EventSubscriptionUpdateParameters"
            />
          description: Updated event subscription information.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-eventgrid.EventSubscription" />&gt;
  - name: >-
      get(string, string, string,
      SystemTopicEventSubscriptionsGetOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.get'
    package: '@azure/arm-eventgrid'
    summary: Get an event subscription.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, systemTopicName: string,
        eventSubscriptionName: string, options?:
        SystemTopicEventSubscriptionsGetOptionalParams):
        Promise<EventSubscription>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-eventgrid.EventSubscription" />&gt;
  - name: >-
      getDeliveryAttributes(string, string, string,
      SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.getDeliveryAttributes'
    package: '@azure/arm-eventgrid'
    summary: Get all delivery attributes for an event subscription.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getDeliveryAttributes(resourceGroupName: string,
        systemTopicName: string, eventSubscriptionName: string, options?:
        SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams):
        Promise<DeliveryAttributeListResult>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref
          uid="@azure/arm-eventgrid.DeliveryAttributeListResult" />&gt;
  - name: >-
      getFullUrl(string, string, string,
      SystemTopicEventSubscriptionsGetFullUrlOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.getFullUrl'
    package: '@azure/arm-eventgrid'
    summary: Get the full endpoint URL for an event subscription of a system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function getFullUrl(resourceGroupName: string, systemTopicName: string,
        eventSubscriptionName: string, options?:
        SystemTopicEventSubscriptionsGetFullUrlOptionalParams):
        Promise<EventSubscriptionFullUrl>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: eventSubscriptionName
          type: string
          description: >-
            Name of the event subscription to be created. Event subscription
            names
                                         must be between 3 and 100 characters in length and use alphanumeric letters only.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsGetFullUrlOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-eventgrid.EventSubscriptionFullUrl"
          />&gt;
  - name: >-
      listBySystemTopic(string, string,
      SystemTopicEventSubscriptionsListBySystemTopicOptionalParams)
    uid: '@azure/arm-eventgrid.SystemTopicEventSubscriptions.listBySystemTopic'
    package: '@azure/arm-eventgrid'
    summary: List event subscriptions that belong to a specific system topic.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listBySystemTopic(resourceGroupName: string, systemTopicName:
        string, options?:
        SystemTopicEventSubscriptionsListBySystemTopicOptionalParams):
        PagedAsyncIterableIterator<EventSubscription, EventSubscription[],
        PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group within the user's subscription.
        - id: systemTopicName
          type: string
          description: Name of the system topic.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-eventgrid.SystemTopicEventSubscriptionsListBySystemTopicOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-eventgrid.EventSubscription" />, <xref
          uid="@azure/arm-eventgrid.EventSubscription" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;