EventSubscriptions interface
EventSubscriptions を表すインターフェイス。
メソッド
メソッドの詳細
beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)
新しいイベント サブスクリプションを非同期的に作成するか、指定したスコープに基づいて既存のイベント サブスクリプションを更新します。
function beginCreateOrUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>
パラメーター
- scope
-
string
イベント サブスクリプションを作成または更新する必要があるリソースの識別子。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 64 文字で、英数字のみを使用する必要があります。
- eventSubscriptionInfo
- EventSubscription
変換先とフィルター情報を含むイベント サブスクリプションのプロパティ。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>
beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)
新しいイベント サブスクリプションを非同期的に作成するか、指定したスコープに基づいて既存のイベント サブスクリプションを更新します。
function beginCreateOrUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>
パラメーター
- scope
-
string
イベント サブスクリプションを作成または更新する必要があるリソースの識別子。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
作成されるイベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 64 文字で、英数字のみを使用する必要があります。
- eventSubscriptionInfo
- EventSubscription
変換先とフィルター情報を含むイベント サブスクリプションのプロパティ。
options パラメーター。
戻り値
Promise<EventSubscription>
beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)
既存のイベント サブスクリプションを削除します。
function beginDelete(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
パラメーター
- scope
-
string
イベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
削除するイベント サブスクリプションの名前。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)
既存のイベント サブスクリプションを削除します。
function beginDeleteAndWait(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<void>
パラメーター
- scope
-
string
イベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
削除するイベント サブスクリプションの名前。
options パラメーター。
戻り値
Promise<void>
beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)
既存のイベント サブスクリプションを非同期的に更新します。
function beginUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>
パラメーター
- scope
-
string
既存のイベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
更新するイベント サブスクリプションの名前。
- eventSubscriptionUpdateParameters
- EventSubscriptionUpdateParameters
イベント サブスクリプション情報を更新しました。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>
beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)
既存のイベント サブスクリプションを非同期的に更新します。
function beginUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>
パラメーター
- scope
-
string
既存のイベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
更新するイベント サブスクリプションの名前。
- eventSubscriptionUpdateParameters
- EventSubscriptionUpdateParameters
イベント サブスクリプション情報を更新しました。
options パラメーター。
戻り値
Promise<EventSubscription>
get(string, string, EventSubscriptionsGetOptionalParams)
イベント サブスクリプションのプロパティを取得します。
function get(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetOptionalParams): Promise<EventSubscription>
パラメーター
- scope
-
string
イベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
見つかるイベント サブスクリプションの名前。
options パラメーター。
戻り値
Promise<EventSubscription>
getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)
イベント サブスクリプションのすべての配信属性を取得します。
function getDeliveryAttributes(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>
パラメーター
- scope
-
string
イベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
イベント サブスクリプションの名前。
options パラメーター。
戻り値
Promise<DeliveryAttributeListResult>
getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)
イベント サブスクリプションの完全なエンドポイント URL を取得します。
function getFullUrl(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>
パラメーター
- scope
-
string
イベント サブスクリプションのスコープ。 スコープには、サブスクリプション、リソース グループ、またはリソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を使用し、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 およびリソースの場合は '/subscriptions/{subscriptionId}/resourceGroupname}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。
- eventSubscriptionName
-
string
イベント サブスクリプションの名前。
options パラメーター。
戻り値
Promise<EventSubscriptionFullUrl>
listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)
特定のドメイン トピックに対して作成されたすべてのイベント サブスクリプションを一覧表示します。
function listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
- domainName
-
string
最上位ドメインの名前。
- topicName
-
string
ドメイン トピックの名前。
options パラメーター。
戻り値
listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)
特定のリソースに対して作成されたすべてのイベント サブスクリプションを一覧表示します。
function listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: EventSubscriptionsListByResourceOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
- providerNamespace
-
string
トピックのプロバイダーの名前空間。
- resourceTypeName
-
string
リソースの種類の名前。
- resourceName
-
string
リソースの名前。
options パラメーター。
戻り値
listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)
特定の Azure サブスクリプションとリソース グループのすべてのグローバル イベント サブスクリプションを一覧表示します。
function listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
options パラメーター。
戻り値
listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)
特定のトピックの種類のリソース グループの下にあるすべてのグローバル イベント サブスクリプションを一覧表示します。
function listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
- topicTypeName
-
string
トピックの種類の名前。
options パラメーター。
戻り値
listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)
特定の Azure サブスクリプションで集計されたすべてのグローバル イベント サブスクリプションを一覧表示します。
function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
options パラメーター。
戻り値
listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)
トピックの種類について、Azure サブスクリプションの下にあるすべてのグローバル イベント サブスクリプションを一覧表示します。
function listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- topicTypeName
-
string
トピックの種類の名前。
options パラメーター。
戻り値
listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)
特定の Azure サブスクリプションとリソース グループの特定の場所からのすべてのイベント サブスクリプションを一覧表示します。
function listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
- location
-
string
場所の名前。
options パラメーター。
戻り値
listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)
特定の Azure サブスクリプションとリソース グループとトピックの種類の下の特定の場所からのすべてのイベント サブスクリプションを一覧表示します。
function listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。
- location
-
string
場所の名前。
- topicTypeName
-
string
トピックの種類の名前。
options パラメーター。
戻り値
listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)
特定の Azure サブスクリプションの特定の場所からのすべてのイベント サブスクリプションを一覧表示します。
function listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- location
-
string
場所の名前。
options パラメーター。
戻り値
listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)
特定の Azure サブスクリプションとトピックの種類の下の特定の場所からのすべてのイベント サブスクリプションを一覧表示します。
function listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>
パラメーター
- location
-
string
場所の名前。
- topicTypeName
-
string
トピックの種類の名前。
options パラメーター。
戻り値
Azure SDK for JavaScript