@azure/arm-eventhub package
Klasser
| EventHubManagementClient |
Gränssnitt
| AccessKeys |
Namnområde/EventHub-anslutningssträng |
| ApplicationGroup |
Programgruppsobjektet |
| ApplicationGroupOperationsCreateOrUpdateApplicationGroupOptionalParams |
Valfria parametrar. |
| ApplicationGroupOperationsDeleteOptionalParams |
Valfria parametrar. |
| ApplicationGroupOperationsGetOptionalParams |
Valfria parametrar. |
| ApplicationGroupOperationsListByNamespaceOptionalParams |
Valfria parametrar. |
| ApplicationGroupOperationsOperations |
Gränssnitt som representerar en ApplicationGroupOperations-operation. |
| ApplicationGroupPolicy |
Egenskaper för programgruppens princip |
| ApplicationGroupProperties |
modellgränssnitt ApplicationGroupProperties |
| ArmDisasterRecovery |
Enstaka objekt i list- eller get-aliasåtgärden (konfiguration av haveriberedskap) |
| ArmDisasterRecoveryProperties |
Egenskaper som krävs för att skapa eller uppdatera alias (haveriberedskapskonfigurationer) |
| AuthorizationRule |
Enstaka objekt i en lista eller hämta AuthorizationRule-åtgärd |
| AuthorizationRuleProperties |
Egenskaper som anges för att skapa eller uppdatera AuthorizationRule |
| AvailableCluster |
Antal företablerade och lättillgängliga Event Hubs-kluster per region. |
| AvailableClustersList |
Svaret från åtgärden Lista tillgängliga kluster. |
| CaptureDescription |
Egenskaper för att konfigurera avbildningsbeskrivning för eventhub |
| CaptureIdentity |
Ett värde som anger om avbildningsbeskrivningen är aktiverad. |
| CheckNameAvailabilityParameter |
Parameter som angetts för att kontrollera namnområdesnamntillgänglighetsåtgärden |
| CheckNameAvailabilityResult |
Resultatet av åtgärden CheckNameAvailability |
| Cluster |
Klusterresurs för enskild händelsehubb i listan eller Hämta åtgärder. |
| ClusterProperties |
Egenskaper för Event Hubs-kluster som anges i svar i List- eller Get-åtgärder. |
| ClusterQuotaConfigurationProperties |
Innehåller alla inställningar för klustret. |
| ClusterSku |
SKU-parametrar som är specifika för en klusterinstans. |
| ClustersCreateOrUpdateOptionalParams |
Valfria parametrar. |
| ClustersDeleteOptionalParams |
Valfria parametrar. |
| ClustersGetOptionalParams |
Valfria parametrar. |
| ClustersListAvailableClusterRegionOptionalParams |
Valfria parametrar. |
| ClustersListByResourceGroupOptionalParams |
Valfria parametrar. |
| ClustersListBySubscriptionOptionalParams |
Valfria parametrar. |
| ClustersListNamespacesOptionalParams |
Valfria parametrar. |
| ClustersOperations |
Gränssnitt som representerar en klusteråtgärd. |
| ClustersUpdateOptionalParams |
Valfria parametrar. |
| ConfidentialCompute |
modellgränssnitt ConfidentialCompute |
| ConfigurationGetOptionalParams |
Valfria parametrar. |
| ConfigurationOperations |
Gränssnitt som representerar konfigurationsoperationer. |
| ConfigurationPatchOptionalParams |
Valfria parametrar. |
| ConnectionState |
ConnectionState-information. |
| ConsumerGroup |
Enstaka objekt i list- eller get consumer-gruppåtgärd |
| ConsumerGroupProperties |
Enstaka objekt i list- eller get consumer-gruppåtgärd |
| ConsumerGroupsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| ConsumerGroupsDeleteOptionalParams |
Valfria parametrar. |
| ConsumerGroupsGetOptionalParams |
Valfria parametrar. |
| ConsumerGroupsListByEventHubOptionalParams |
Valfria parametrar. |
| ConsumerGroupsOperations |
Gränssnitt som representerar en ConsumerGroups-operation. |
| Destination |
Samla in lagringsinformation för avbildningsbeskrivning |
| DestinationProperties |
Egenskaper som beskriver lagringskontot, blobcontainern och arkivnamnsformatet för avbildningsmål |
| DisasterRecoveryConfigsBreakPairingOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsDeleteOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsFailOverOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsGetOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsListAuthorizationRulesOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsListKeysOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsListOptionalParams |
Valfria parametrar. |
| DisasterRecoveryConfigsOperations |
Gränssnitt som representerar en DisasterRecoveryConfigs-operation. |
| EHNamespace |
Enstaka namnområdesobjekt i lista eller hämta åtgärd |
| EHNamespaceIdContainer |
Det fullständiga ARM-ID:t för ett Event Hubs-namnområde |
| EHNamespaceIdListResult |
Svaret för åtgärden listnamnområdes-ID:t |
| EHNamespaceProperties |
Namnområdesegenskaper som angetts för att skapa namnområdesåtgärd. |
| Encryption |
Egenskaper för att konfigurera kryptering |
| ErrorAdditionalInfo |
Ytterligare information om resurshanteringsfelet. |
| ErrorDetail |
Felinformationen. |
| ErrorResponse |
Felsvaret anger att Event Hub-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. |
| EventHubManagementClientOptionalParams |
Valfria parametrar för klienten. |
| EventHubsCreateOrUpdateAuthorizationRuleOptionalParams |
Valfria parametrar. |
| EventHubsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| EventHubsDeleteAuthorizationRuleOptionalParams |
Valfria parametrar. |
| EventHubsDeleteOptionalParams |
Valfria parametrar. |
| EventHubsGetAuthorizationRuleOptionalParams |
Valfria parametrar. |
| EventHubsGetOptionalParams |
Valfria parametrar. |
| EventHubsListAuthorizationRulesOptionalParams |
Valfria parametrar. |
| EventHubsListByNamespaceOptionalParams |
Valfria parametrar. |
| EventHubsListKeysOptionalParams |
Valfria parametrar. |
| EventHubsOperations |
Gränssnitt som representerar en EventHubs-operation. |
| EventHubsRegenerateKeysOptionalParams |
Valfria parametrar. |
| Eventhub |
Enstaka objekt i Listan eller Hämta händelsehubbåtgärd |
| EventhubProperties |
Egenskaper som anges för åtgärden Skapa eller uppdatera händelsehubben. |
| FailOver |
modellgränssnitt FailOver |
| FailOverProperties |
modellgränssnitt FailOverProperties |
| GeoDataReplicationProperties |
Egenskaper för GeoDR-replikering |
| Identity |
Egenskaper för att konfigurera identitet för Bring Your Own Keys |
| KeyVaultProperties |
Egenskaper för att konfigurera keyVault-egenskaper |
| MessageTimestampDescription |
Egenskaper för MessageTimestamp-beskrivning |
| NWRuleSetIpRules |
Svaret från listnamnområdesåtgärden. |
| NWRuleSetVirtualNetworkRules |
Svaret från listnamnområdesåtgärden. |
| NamespaceReplicaLocation |
Egenskaper för namnområdesreplikering |
| NamespacesCheckNameAvailabilityOptionalParams |
Valfria parametrar. |
| NamespacesCreateOrUpdateAuthorizationRuleOptionalParams |
Valfria parametrar. |
| NamespacesCreateOrUpdateNetworkRuleSetOptionalParams |
Valfria parametrar. |
| NamespacesCreateOrUpdateOptionalParams |
Valfria parametrar. |
| NamespacesDeleteAuthorizationRuleOptionalParams |
Valfria parametrar. |
| NamespacesDeleteOptionalParams |
Valfria parametrar. |
| NamespacesFailoverOptionalParams |
Valfria parametrar. |
| NamespacesGetAuthorizationRuleOptionalParams |
Valfria parametrar. |
| NamespacesGetNetworkRuleSetOptionalParams |
Valfria parametrar. |
| NamespacesGetOptionalParams |
Valfria parametrar. |
| NamespacesListAuthorizationRulesOptionalParams |
Valfria parametrar. |
| NamespacesListByResourceGroupOptionalParams |
Valfria parametrar. |
| NamespacesListKeysOptionalParams |
Valfria parametrar. |
| NamespacesListNetworkRuleSetOptionalParams |
Valfria parametrar. |
| NamespacesListOptionalParams |
Valfria parametrar. |
| NamespacesOperations |
Gränssnitt som representerar åtgärder för namnområden. |
| NamespacesRegenerateKeysOptionalParams |
Valfria parametrar. |
| NamespacesUpdateOptionalParams |
Valfria parametrar. |
| NetworkRuleSet |
Beskrivning av ämnesresurs. |
| NetworkRuleSetListResult |
En sidindelad samling NetworkRuleSet-objekt |
| NetworkRuleSetProperties |
NetworkRuleSet-egenskaper |
| NetworkSecurityPerimeter |
NetworkSecurityPerimeter-relaterad information |
| NetworkSecurityPerimeterConfiguration |
Nätverkssäkerhetsperimeterrelaterade konfigurationer för ett angivet namnområde |
| NetworkSecurityPerimeterConfigurationList |
Resultatet av åtgärden List NetworkSecurityPerimeterConfiguration. |
| NetworkSecurityPerimeterConfigurationOperationsListOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationOperationsOperations |
Gränssnitt som representerar en NetworkSecurityPerimeterConfigurationOperations-operationer. |
| NetworkSecurityPerimeterConfigurationProperties |
Egenskaper hos NetworkSecurityPerimeterConfiguration |
| NetworkSecurityPerimeterConfigurationPropertiesProfile |
Information om aktuell nätverksprofil |
| NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Information om resursassociation |
| NetworkSecurityPerimeterConfigurationsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationsGetResourceAssociationNameOptionalParams |
Valfria parametrar. |
| NetworkSecurityPerimeterConfigurationsOperations |
Gränssnitt som representerar NetworkSecurityPerimeterConfigurations-operationer. |
| NspAccessRule |
Information om åtkomstregel i nätverksprofil |
| NspAccessRuleProperties |
Egenskaper för åtkomstregel |
| NspAccessRulePropertiesSubscriptionsItem |
Prenumeration för inkommande regel |
| Operation |
En REST API-åtgärd för Event Hub |
| OperationDisplay |
Nyttolast för åtgärdsvisning |
| OperationsListOptionalParams |
Valfria parametrar. |
| OperationsOperations |
Gränssnitt som representerar åtgärder. |
| PageSettings |
Alternativ för byPage-metoden |
| PagedAsyncIterableIterator |
Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida. |
| PlatformCapabilities |
modellgränssnitt PlatformCapabilities |
| PrivateEndpoint |
PrivateEndpoint-information. |
| PrivateEndpointConnection |
Egenskaper för PrivateEndpointConnection. |
| PrivateEndpointConnectionProperties |
Egenskaper hos den privata slutpunktsanslutningsresursen. |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsGetOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsListOptionalParams |
Valfria parametrar. |
| PrivateEndpointConnectionsOperations |
Gränssnitt som representerar en PrivateEndpointConnections-åtgärder. |
| PrivateLinkResource |
Information om den privata länkresursen. |
| PrivateLinkResourceProperties |
Egenskaper hos PrivateLinkResource |
| PrivateLinkResourcesGetOptionalParams |
Valfria parametrar. |
| PrivateLinkResourcesListResult |
En sidindelad samling av PrivateLinkResource-objekt |
| PrivateLinkResourcesOperations |
Gränssnitt som representerar en PrivateLinkResources-åtgärd. |
| ProvisioningIssue |
Beskriver etableringsproblem för angiven NetworkSecurityPerimeterConfiguration |
| ProvisioningIssueProperties |
Egenskaper för etableringsproblem |
| ProxyResource |
Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats |
| RegenerateAccessKeyParameters |
Parametrar som anges i åtgärden Återskapa auktoriseringsregel anger vilken nyckel som måste återställas. |
| Resource |
Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser |
| RestorePollerOptions | |
| RetentionDescription |
Egenskaper för att konfigurera kvarhållningsinställningar för eventhub |
| SchemaGroup |
Åtgärd för enstaka objekt i listan eller Hämta schemagrupp |
| SchemaGroupProperties |
modellgränssnitt SchemaGroupProperties |
| SchemaRegistryCreateOrUpdateOptionalParams |
Valfria parametrar. |
| SchemaRegistryDeleteOptionalParams |
Valfria parametrar. |
| SchemaRegistryGetOptionalParams |
Valfria parametrar. |
| SchemaRegistryListByNamespaceOptionalParams |
Valfria parametrar. |
| SchemaRegistryOperations |
Gränssnitt som representerar en SchemaRegistry-operation. |
| SimplePollerLike |
En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd. |
| Sku |
SKU-parametrar som angetts för åtgärden skapa namnområde |
| Subnet |
Egenskaper som anges för undernätet |
| SystemData |
Metadata som rör skapande och senaste ändring av resursen. |
| ThrottlingPolicy |
Egenskaper för begränsningsprincipen |
| UserAssignedIdentity |
Identifierat ordlistevärde. |
| UserAssignedIdentityProperties |
modellgränssnitt UserAssignedIdentityProperties |
Typalias
| AccessRights |
Typ av AccessRights |
| ApplicationGroupPolicyType |
Typer av applikationsgrupppolicyer Kända värden som stöds av tjänstenThrottlingPolicy |
| ApplicationGroupPolicyUnion |
Alias för ApplicationGroupPolicyUnion |
| AzureSupportedClouds |
De värden som stöds för molninställningen som en strängliteraltyp |
| CaptureIdentityType |
Typ av Azure Active Directory hanterad identitet. |
| CleanupPolicyRetentionDescription |
Räknar upp möjliga värden för saneringspolicyn Kända värden som stöds av tjänsten
Ta bort |
| ClusterSkuName |
Namnet på den här SKU:n. Kända värden som stöds av tjänstenDedikerad |
| ContinuablePage |
Ett gränssnitt som beskriver en resultatsida. |
| CreatedByType |
Den typ av entitet som skapade resursen. Kända värden som stöds av tjänsten
Användare: Entiteten skapades av en användare. |
| DefaultAction |
Standardåtgärd för nätverksregeluppsättning Kända värden som stöds av tjänsten
Tillåt |
| EncodingCaptureDescription |
Räknar upp möjliga värden för kodningsformatet för avbildningsbeskrivningen. Obs! "AvroDeflate" kommer att bli inaktuell i ny API-version |
| EndPointProvisioningState |
Etableringstillstånd för den privata slutpunktsanslutningen. Kända värden som stöds av tjänsten
Skapa |
| EntityStatus |
Räknar upp möjliga värden för händelsehubbens status. |
| GeoDRRoleType |
GeoDR-rolltyper Kända värden som stöds av tjänsten
primär |
| KeyType |
Åtkomstnyckeln som ska återskapas. Kända värden som stöds av tjänsten
PrimaryKey |
| ManagedServiceIdentityType |
Typ av hanterad tjänstidentitet. |
| MetricId |
Metric ID där gasbegränsningen ska sättas, MetricId kan upptäckas genom att hålla muspekaren över Metric i Metrics-sektionen i Event Hub Namespace inne i Azure Portal Kända värden som stöds av tjänsten
IncomingBytes |
| Mode |
Inställning för att aktivera eller inaktivera konfidentiell beräkning Kända värden som stöds av tjänsten
inaktiverad |
| NetworkRuleIPAction |
IP-filteråtgärden Kända värden som stöds av tjänstenTillåt |
| NetworkSecurityPerimeterConfigurationProvisioningState |
Provisioneringstillstånd för NetworkSecurityPerimeter-konfigurationspropagation Kända värden som stöds av tjänsten
Okänd |
| NspAccessRuleDirection |
Åtkomstriktningsregeln Kända värden som stöds av tjänsten
Inkommande |
| PrivateLinkConnectionStatus |
Status för anslutningen. Kända värden som stöds av tjänsten
väntar på |
| ProvisioningState |
Etableringstillstånd för klustret. Kända värden som stöds av tjänsten
Okänd |
| ProvisioningStateDR |
Etableringstillstånd för aliaset (haveriberedskapskonfiguration) – möjliga värden "Accepterade" eller "Lyckades" eller "Misslyckades" |
| PublicNetworkAccess |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Kända värden som stöds av tjänsten
aktiverat |
| PublicNetworkAccessFlag |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Om värdet är SecuredByPerimeter styrs inkommande och utgående kommunikation av nätverkssäkerhetsperimetern och profilens åtkomstregler. Kända värden som stöds av tjänsten
aktiverat |
| ResourceAssociationAccessMode |
Åtkomstläge för resursassociationen Kända värden som stöds av tjänsten
NoAssociationMode |
| RoleDisasterRecovery |
roll för namnområdet i GEO DR – möjliga värden "Primär" eller "PrimaryNotReplicating" eller "Sekundär" |
| SchemaCompatibility |
Typ av schemaKompatibilitet |
| SchemaType |
Typ av schemaType |
| SkuName |
Namnet på den här SKU:n. Kända värden som stöds av tjänsten
Grundläggande |
| SkuTier |
Faktureringsnivån för den här specifika SKU:n. Kända värden som stöds av tjänsten
Grundläggande |
| TimestampType |
Anger vilken typ av tidsstämpel meddelandet ska innehålla. Två typer av tidsstämpeltyper – "AppendTime" och "CreateTime". AppendTime refererar till den tid då meddelandet läggs till i koordinatorloggen. CreateTime refererar till den tid då meddelandet genererades på källsidan och producenter kan ange tidsstämpeln när meddelandet skickas. Standardvärdet är AppendTime. Om du använder AMQP-protokollet är CreateTime lika med AppendTime och dess beteende förblir detsamma. Kända värden som stöds av tjänsten
LogAppend |
| TlsVersion |
Den minsta TLS-versionen för klustret att stödja, t.ex. '1.2' Kända värden som stöds av tjänsten
1,0 |
| UnavailableReason |
Anger orsaken till att tjänsten inte är tillgänglig. |
Uppräkningar
| AzureClouds |
Ett enum för att beskriva Azure Cloud-miljöer. |
| KnownAccessRights |
Kända värden för AccessRights som tjänsten accepterar. |
| KnownApplicationGroupPolicyType |
Typer av programgruppprinciper |
| KnownCleanupPolicyRetentionDescription |
Räknar upp möjliga värden för rensningsprincip |
| KnownClusterSkuName |
Namnet på den här SKU:n. |
| KnownCreatedByType |
Den typ av entitet som skapade resursen. |
| KnownDefaultAction |
Standardåtgärd för nätverksregeluppsättning |
| KnownEndPointProvisioningState |
Etableringstillstånd för den privata slutpunktsanslutningen. |
| KnownGeoDRRoleType |
GeoDR-rolltyper |
| KnownKeyType |
Åtkomstnyckeln som ska återskapas. |
| KnownMetricId |
Mått-ID som begränsningsgränsen ska anges på, MetricId kan identifieras genom att hovra över Mått i avsnittet Mått i Event Hub-namnområdet i Azure Portal |
| KnownMode |
Inställning för att aktivera eller inaktivera konfidentiell beräkning |
| KnownNetworkRuleIPAction |
IP-filteråtgärden |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
Etableringstillstånd för konfigurationsspridning för NetworkSecurityPerimeter |
| KnownNspAccessRuleDirection |
Regel för åtkomstriktning |
| KnownPrivateLinkConnectionStatus |
Status för anslutningen. |
| KnownProvisioningState |
Etableringstillstånd för klustret. |
| KnownPublicNetworkAccess |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. |
| KnownPublicNetworkAccessFlag |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Om värdet är SecuredByPerimeter styrs inkommande och utgående kommunikation av nätverkssäkerhetsperimetern och profilens åtkomstregler. |
| KnownResourceAssociationAccessMode |
Åtkomstläge för resursassociationen |
| KnownSchemaCompatibility |
Kända värden för SchemaCompatibility som tjänsten accepterar. |
| KnownSchemaType |
Kända värden för SchemaType- som tjänsten accepterar. |
| KnownSkuName |
Namnet på den här SKU:n. |
| KnownSkuTier |
Faktureringsnivån för den här specifika SKU:n. |
| KnownTimestampType |
Anger vilken typ av tidsstämpel meddelandet ska innehålla. Två typer av tidsstämpeltyper – "AppendTime" och "CreateTime". AppendTime refererar till den tid då meddelandet läggs till i koordinatorloggen. CreateTime refererar till den tid då meddelandet genererades på källsidan och producenter kan ange tidsstämpeln när meddelandet skickas. Standardvärdet är AppendTime. Om du använder AMQP-protokollet är CreateTime lika med AppendTime och dess beteende förblir detsamma. |
| KnownTlsVersion |
Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2" |
| KnownVersions |
Tillgängliga API-versioner. |
Funktioner
| is |
Typeguard för RestError |
| restore |
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget. |
Variabler
| Rest |
En anpassad feltyp för misslyckade pipelinebegäranden. |
Funktionsinformation
isRestError(unknown)
Typeguard för RestError
function isRestError(e: unknown): e
Parametrar
- e
-
unknown
Något som fångas av en fångstklausul.
Returer
e
restorePoller<TResponse, TResult>(EventHubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.
function restorePoller<TResponse, TResult>(client: EventHubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametrar
- client
- EventHubManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returer
PollerLike<OperationState<TResult>, TResult>
Variabelinformation
RestError
En anpassad feltyp för misslyckade pipelinebegäranden.
RestError: RestErrorConstructor