@azure/arm-webpubsub package
Interfejsy
| CustomCertificate |
Certyfikat niestandardowy. |
| CustomCertificateList |
Lista certyfikatów niestandardowych. |
| CustomDomain |
Domena niestandardowa |
| CustomDomainList |
Lista domen niestandardowych |
| Dimension |
Specyfikacje wymiaru metryk. |
| ErrorAdditionalInfo |
Dodatkowe informacje o błędzie zarządzania zasobami. |
| ErrorDetail |
Szczegóły błędu. |
| ErrorResponse |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
| EventHandler |
Właściwości programu obsługi zdarzeń. |
| EventHubEndpoint |
Punkt końcowy centrum zdarzeń. Tożsamość zarządzana usługi Web PubSub musi być włączona, a tożsamość powinna mieć rolę "Nadawca danych usługi Azure Event Hubs", aby uzyskać dostęp do centrum zdarzeń. |
| EventListener |
Ustawienie określa, które rodzaje zdarzeń powinny być wysyłane do którego punktu końcowego. |
| EventListenerEndpoint |
Punkt końcowy określający miejsce wysyłania zdarzeń do usługi Web PubSub. |
| EventListenerFilter |
Klasa podstawowa filtru zdarzeń, który określa, czy zdarzenie powinno być wysyłane do odbiornika zdarzeń. |
| EventNameFilter |
Filtruj zdarzenia według ich nazwy. |
| IPRule |
Reguła adresu IP |
| LiveTraceCategory |
Konfiguracja kategorii śledzenia na żywo zasobu Microsoft.SignalRService. |
| LiveTraceConfiguration |
Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. |
| LogSpecification |
Specyfikacje dzienników monitorowania platformy Azure. |
| ManagedIdentity |
Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi |
| ManagedIdentitySettings |
Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. |
| MetricSpecification |
Specyfikacje metryk monitorowania platformy Azure. |
| NameAvailability |
Wynik żądania sprawdzania dostępności nazwy. Zawiera flagę i możliwą przyczynę niepowodzenia. |
| NameAvailabilityParameters |
Dane POST-ed do akcji nameAvailability |
| NetworkACL |
Lista ACL sieci |
| Operation |
Operacja interfejsu API REST obsługiwana przez dostawcę zasobów. |
| OperationDisplay |
Obiekt, który opisuje operację. |
| OperationList |
Wynik żądania wyświetlania listy operacji interfejsu API REST. Zawiera listę operacji. |
| OperationProperties |
Właściwości dodatkowej operacji. |
| Operations |
Interfejs reprezentujący operacje. |
| OperationsListNextOptionalParams |
Parametry opcjonalne. |
| OperationsListOptionalParams |
Parametry opcjonalne. |
| PrivateEndpoint |
Prywatny punkt końcowy |
| PrivateEndpointACL |
Lista ACL dla prywatnego punktu końcowego |
| PrivateEndpointConnection |
Połączenie prywatnego punktu końcowego z zasobem platformy Azure |
| PrivateEndpointConnectionList |
Lista połączeń prywatnych punktów końcowych |
| PrivateLinkResource |
Zasób łącza prywatnego |
| PrivateLinkResourceList |
Zawiera listę elementów PrivateLinkResource i możliwy link do wykonywania zapytań o więcej wyników |
| PrivateLinkServiceConnectionState |
Stan połączenia prywatnego punktu końcowego |
| ProxyResource |
Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji |
| RegenerateKeyParameters |
Parametry opisują żądanie ponownego generowania kluczy dostępu |
| Replica |
Klasa reprezentuje zasób repliki. |
| ReplicaList | |
| Resource |
Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager |
| ResourceLogCategory |
Konfiguracja kategorii dzienników zasobów zasobu Microsoft.SignalRService. |
| ResourceLogConfiguration |
Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. |
| ResourceReference |
Odwołanie do zasobu. |
| ResourceSku |
Informacje o rozliczeniach zasobu. |
| ServiceSpecification |
Obiekt opisujący specyfikację. |
| ShareablePrivateLinkResourceProperties |
Opisuje właściwości typu zasobu, który został dołączony do usługi łącza prywatnego |
| ShareablePrivateLinkResourceType |
Opisuje typ zasobu, który został dołączony do usługi łącza prywatnego |
| SharedPrivateLinkResource |
Opisuje udostępniony zasób usługi Private Link |
| SharedPrivateLinkResourceList |
Lista udostępnionych zasobów łącza prywatnego |
| SignalRServiceUsage |
Obiekt opisujący określone użycie zasobów. |
| SignalRServiceUsageList |
Obiekt zawierający tablicę użycia zasobów i możliwy link do następnego zestawu. |
| SignalRServiceUsageName |
Lokalizowalny obiekt String zawierający nazwę i zlokalizowaną wartość. |
| Sku |
Opisuje dostępną jednostkę SKU". |
| SkuCapacity |
Opisuje informacje o skalowaniu jednostki SKU. |
| SkuList |
Odpowiedź operacji jednostki SKU listy |
| SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
| TrackedResource |
Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację" |
| UpstreamAuthSettings |
Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. |
| Usages |
Interfejs reprezentujący użycie. |
| UsagesListNextOptionalParams |
Parametry opcjonalne. |
| UsagesListOptionalParams |
Parametry opcjonalne. |
| UserAssignedIdentityProperty |
Właściwości tożsamości przypisanej przez użytkownika. |
| WebPubSub |
Interfejs reprezentujący element WebPubSub. |
| WebPubSubCheckNameAvailabilityOptionalParams |
Parametry opcjonalne. |
| WebPubSubCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomCertificates |
Interfejs reprezentujący element WebPubSubCustomCertificates. |
| WebPubSubCustomCertificatesCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomCertificatesDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomCertificatesGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomCertificatesListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomCertificatesListOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomDomains |
Interfejs reprezentujący element WebPubSubCustomDomains. |
| WebPubSubCustomDomainsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomDomainsDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomDomainsGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomDomainsListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubCustomDomainsListOptionalParams |
Parametry opcjonalne. |
| WebPubSubDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubHub |
Ustawienie centrum |
| WebPubSubHubList |
Lista ustawień centrum |
| WebPubSubHubProperties |
Właściwości centrum. |
| WebPubSubHubs |
Interfejs reprezentujący witrynę WebPubSubHubs. |
| WebPubSubHubsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubHubsDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubHubsGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubHubsListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubHubsListOptionalParams |
Parametry opcjonalne. |
| WebPubSubKeys |
Klasa reprezentuje klucze dostępu zasobu. |
| WebPubSubListByResourceGroupNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubListByResourceGroupOptionalParams |
Parametry opcjonalne. |
| WebPubSubListBySubscriptionNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubListBySubscriptionOptionalParams |
Parametry opcjonalne. |
| WebPubSubListKeysOptionalParams |
Parametry opcjonalne. |
| WebPubSubListReplicaSkusOptionalParams |
Parametry opcjonalne. |
| WebPubSubListSkusOptionalParams |
Parametry opcjonalne. |
| WebPubSubManagementClientOptionalParams |
Parametry opcjonalne. |
| WebPubSubNetworkACLs |
Listy ACL sieci dla zasobu |
| WebPubSubPrivateEndpointConnections |
Interfejs reprezentujący element WebPubSubPrivateEndpointConnections. |
| WebPubSubPrivateEndpointConnectionsDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateEndpointConnectionsGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateEndpointConnectionsListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateEndpointConnectionsListOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateEndpointConnectionsUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateLinkResources |
Interfejs reprezentujący element WebPubSubPrivateLinkResources. |
| WebPubSubPrivateLinkResourcesListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubPrivateLinkResourcesListOptionalParams |
Parametry opcjonalne. |
| WebPubSubRegenerateKeyHeaders |
Definiuje nagłówki dla operacji WebPubSub_regenerateKey. |
| WebPubSubRegenerateKeyOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicaSharedPrivateLinkResources |
Interfejs reprezentujący element WebPubSubReplicaSharedPrivateLinkResources. |
| WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicas |
Interfejs reprezentujący element WebPubSubReplicas. |
| WebPubSubReplicasCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasListOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasRestartHeaders |
Definiuje nagłówki dla operacji WebPubSubReplicas_restart. |
| WebPubSubReplicasRestartOptionalParams |
Parametry opcjonalne. |
| WebPubSubReplicasUpdateHeaders |
Definiuje nagłówki dla operacji WebPubSubReplicas_update. |
| WebPubSubReplicasUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubResource |
Klasa reprezentuje zasób. |
| WebPubSubResourceList |
Obiekt zawierający tablicę zasobów i możliwy link do następnego zestawu. |
| WebPubSubRestartHeaders |
Definiuje nagłówki dla operacji WebPubSub_restart. |
| WebPubSubRestartOptionalParams |
Parametry opcjonalne. |
| WebPubSubSharedPrivateLinkResources |
Interfejs reprezentujący element WebPubSubSharedPrivateLinkResources. |
| WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams |
Parametry opcjonalne. |
| WebPubSubSharedPrivateLinkResourcesGetOptionalParams |
Parametry opcjonalne. |
| WebPubSubSharedPrivateLinkResourcesListNextOptionalParams |
Parametry opcjonalne. |
| WebPubSubSharedPrivateLinkResourcesListOptionalParams |
Parametry opcjonalne. |
| WebPubSubSocketIOSettings |
Ustawienia socketIO dla zasobu |
| WebPubSubTlsSettings |
Ustawienia protokołu TLS dla zasobu |
| WebPubSubUpdateHeaders |
Definiuje nagłówki dla operacji WebPubSub_update. |
| WebPubSubUpdateOptionalParams |
Parametry opcjonalne. |
Aliasy typu
| ACLAction |
Definiuje wartości dla usługi ACLAction. Znane wartości obsługiwane przez usługę
Zezwalaj na |
| CreatedByType |
Definiuje wartości createdByType. Znane wartości obsługiwane przez usługę
użytkownika |
| EventListenerEndpointDiscriminator |
Definiuje wartości elementu EventListenerEndpointDiscriminator. Znane wartości obsługiwane przez usługę |
| EventListenerEndpointUnion | |
| EventListenerFilterDiscriminator |
Definiuje wartości elementu EventListenerFilterDiscriminator. Znane wartości obsługiwane przez usługęEventName |
| EventListenerFilterUnion | |
| KeyType |
Definiuje wartości typu KeyType. Znane wartości obsługiwane przez usługę
podstawowa |
| ManagedIdentityType |
Definiuje wartości managedIdentityType. Znane wartości obsługiwane przez usługę
Brak |
| OperationsListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| OperationsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| PrivateLinkServiceConnectionStatus |
Definiuje wartości parametru PrivateLinkServiceConnectionStatus. Znane wartości obsługiwane przez usługę
oczekujące |
| ProvisioningState |
Definiuje wartości parametru ProvisioningState. Znane wartości obsługiwane przez usługę
Nieznany |
| ScaleType |
Definiuje wartości typu ScaleType. Znane wartości obsługiwane przez usługę
Brak |
| ServiceKind |
Definiuje wartości dla elementu ServiceKind. Znane wartości obsługiwane przez usługę |
| SharedPrivateLinkResourceStatus |
Definiuje wartości sharedPrivateLinkResourceStatus. Znane wartości obsługiwane przez usługę
oczekujące |
| UpstreamAuthType |
Definiuje wartości dla parametru UpstreamAuthType. Znane wartości obsługiwane przez usługę
Brak |
| UsagesListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| UsagesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubCheckNameAvailabilityResponse |
Zawiera dane odpowiedzi dla operacji checkNameAvailability. |
| WebPubSubCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubCustomCertificatesCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubCustomCertificatesGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubCustomCertificatesListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubCustomCertificatesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubCustomDomainsCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubCustomDomainsGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubCustomDomainsListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubCustomDomainsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubHubsCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubHubsGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubHubsListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubHubsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubListByResourceGroupNextResponse |
Zawiera dane odpowiedzi dla operacji listByResourceGroupNext. |
| WebPubSubListByResourceGroupResponse |
Zawiera dane odpowiedzi dla operacji listByResourceGroup. |
| WebPubSubListBySubscriptionNextResponse |
Zawiera dane odpowiedzi dla operacji listBySubscriptionNext. |
| WebPubSubListBySubscriptionResponse |
Zawiera dane odpowiedzi dla operacji listBySubscription. |
| WebPubSubListKeysResponse |
Zawiera dane odpowiedzi dla operacji listKeys. |
| WebPubSubListReplicaSkusResponse |
Zawiera dane odpowiedzi dla operacji listReplicaSkus. |
| WebPubSubListSkusResponse |
Zawiera dane odpowiedzi dla operacji listSkus. |
| WebPubSubPrivateEndpointConnectionsGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubPrivateEndpointConnectionsListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubPrivateEndpointConnectionsListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubPrivateEndpointConnectionsUpdateResponse |
Zawiera dane odpowiedzi dla operacji aktualizacji. |
| WebPubSubPrivateLinkResourcesListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubPrivateLinkResourcesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubRegenerateKeyResponse |
Zawiera dane odpowiedzi dla operacji regenerateKey. |
| WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubReplicaSharedPrivateLinkResourcesGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubReplicaSharedPrivateLinkResourcesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubReplicasCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubReplicasGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubReplicasListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubReplicasListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubReplicasRestartResponse |
Zawiera dane odpowiedzi dla operacji ponownego uruchamiania. |
| WebPubSubReplicasUpdateResponse |
Zawiera dane odpowiedzi dla operacji aktualizacji. |
| WebPubSubRequestType |
Definiuje wartości właściwości WebPubSubRequestType. Znane wartości obsługiwane przez usługę
ClientConnection |
| WebPubSubRestartResponse |
Zawiera dane odpowiedzi dla operacji ponownego uruchamiania. |
| WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse |
Zawiera dane odpowiedzi dla operacji createOrUpdate. |
| WebPubSubSharedPrivateLinkResourcesGetResponse |
Zawiera dane odpowiedzi dla operacji pobierania. |
| WebPubSubSharedPrivateLinkResourcesListNextResponse |
Zawiera dane odpowiedzi dla operacji listDalej. |
| WebPubSubSharedPrivateLinkResourcesListResponse |
Zawiera dane odpowiedzi dla operacji listy. |
| WebPubSubSkuTier |
Definiuje wartości webPubSubSkuTier. Znane wartości obsługiwane przez usługę
Bezpłatne |
| WebPubSubUpdateResponse |
Zawiera dane odpowiedzi dla operacji aktualizacji. |
Wyliczenia
Funkcje
| get |
Biorąc pod uwagę ostatni |
Szczegóły funkcji
getContinuationToken(unknown)
Biorąc pod uwagę ostatni .value wygenerowany przez iterator byPage, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.
function getContinuationToken(page: unknown): string | undefined
Parametry
- page
-
unknown
Obiekt z uzyskiwania dostępu do value w iteratorzeResult z iteratora byPage.
Zwraca
string | undefined
Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.