@azure/arm-apicenter package

Klasy

AzureAPICenter

Interfejsy

Api	Jednostka interfejsu API.
ApiDefinition	Jednostka definicji interfejsu API.
ApiDefinitionListResult	Odpowiedź operacji listy ApiDefinition.
ApiDefinitionProperties	Jednostka właściwości definicji interfejsu API.
ApiDefinitionPropertiesSpecification	Szczegóły specyfikacji interfejsu API.
ApiDefinitions	Interfejs reprezentujący interfejs APIDefinitions.
ApiDefinitionsCreateOrUpdateHeaders	Definiuje nagłówki dla operacji ApiDefinitions_createOrUpdate.
ApiDefinitionsCreateOrUpdateOptionalParams	Parametry opcjonalne.
ApiDefinitionsDeleteOptionalParams	Parametry opcjonalne.
ApiDefinitionsExportSpecificationHeaders	Definiuje nagłówki dla operacji ApiDefinitions_exportSpecification.
ApiDefinitionsExportSpecificationOptionalParams	Parametry opcjonalne.
ApiDefinitionsGetHeaders	Definiuje nagłówki dla operacji ApiDefinitions_get.
ApiDefinitionsGetOptionalParams	Parametry opcjonalne.
ApiDefinitionsHeadOptionalParams	Parametry opcjonalne.
ApiDefinitionsImportSpecificationHeaders	Definiuje nagłówki dla operacji ApiDefinitions_importSpecification.
ApiDefinitionsImportSpecificationOptionalParams	Parametry opcjonalne.
ApiDefinitionsListNextOptionalParams	Parametry opcjonalne.
ApiDefinitionsListOptionalParams	Parametry opcjonalne.
ApiListResult	Odpowiedź operacji listy interfejsu API.
ApiProperties	Właściwości interfejsu API.
ApiSpecExportResult	Wynik eksportu specyfikacji interfejsu API.
ApiSpecImportRequest	Właściwości jednostki źródłowej specyfikacji interfejsu API.
ApiSpecImportRequestSpecification	Szczegóły specyfikacji interfejsu API.
ApiVersion	Jednostka wersji interfejsu API.
ApiVersionListResult	Odpowiedź operacji listy ApiVersion.
ApiVersionProperties	Jednostka właściwości wersji interfejsu API.
ApiVersions	Interfejs reprezentujący interfejs ApiVersions.
ApiVersionsCreateOrUpdateHeaders	Definiuje nagłówki dla operacji ApiVersions_createOrUpdate.
ApiVersionsCreateOrUpdateOptionalParams	Parametry opcjonalne.
ApiVersionsDeleteOptionalParams	Parametry opcjonalne.
ApiVersionsGetHeaders	Definiuje nagłówki dla operacji ApiVersions_get.
ApiVersionsGetOptionalParams	Parametry opcjonalne.
ApiVersionsHeadOptionalParams	Parametry opcjonalne.
ApiVersionsListNextOptionalParams	Parametry opcjonalne.
ApiVersionsListOptionalParams	Parametry opcjonalne.
Apis	Interfejs reprezentujący interfejs APIs.
ApisCreateOrUpdateHeaders	Definiuje nagłówki dla operacji Apis_createOrUpdate.
ApisCreateOrUpdateOptionalParams	Parametry opcjonalne.
ApisDeleteOptionalParams	Parametry opcjonalne.
ApisGetHeaders	Definiuje nagłówki dla operacji Apis_get.
ApisGetOptionalParams	Parametry opcjonalne.
ApisHeadOptionalParams	Parametry opcjonalne.
ApisListNextOptionalParams	Parametry opcjonalne.
ApisListOptionalParams	Parametry opcjonalne.
AzureAPICenterOptionalParams	Parametry opcjonalne.
Contact	Informacje kontaktowe
Deployment	Jednostka wdrażania interfejsu API.
DeploymentListResult	Odpowiedź operacji listy wdrożenia.
DeploymentProperties	Właściwości jednostki wdrażania interfejsu API.
DeploymentServer	Serwer
Deployments	Interfejs reprezentujący wdrożenia.
DeploymentsCreateOrUpdateHeaders	Definiuje nagłówki dla operacji Deployments_createOrUpdate.
DeploymentsCreateOrUpdateOptionalParams	Parametry opcjonalne.
DeploymentsDeleteOptionalParams	Parametry opcjonalne.
DeploymentsGetHeaders	Definiuje nagłówki dla operacji Deployments_get.
DeploymentsGetOptionalParams	Parametry opcjonalne.
DeploymentsHeadOptionalParams	Parametry opcjonalne.
DeploymentsListNextOptionalParams	Parametry opcjonalne.
DeploymentsListOptionalParams	Parametry opcjonalne.
Environment	Jednostka środowiska.
EnvironmentListResult	Odpowiedź operacji listy środowiska.
EnvironmentProperties	Jednostka właściwości środowiska.
EnvironmentServer	Informacje o serwerze środowiska.
Environments	Interfejs reprezentujący środowiska.
EnvironmentsCreateOrUpdateHeaders	Definiuje nagłówki dla operacji Environments_createOrUpdate.
EnvironmentsCreateOrUpdateOptionalParams	Parametry opcjonalne.
EnvironmentsDeleteOptionalParams	Parametry opcjonalne.
EnvironmentsGetHeaders	Definiuje nagłówki dla operacji Environments_get.
EnvironmentsGetOptionalParams	Parametry opcjonalne.
EnvironmentsHeadOptionalParams	Parametry opcjonalne.
EnvironmentsListNextOptionalParams	Parametry opcjonalne.
EnvironmentsListOptionalParams	Parametry opcjonalne.
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 zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
ExternalDocumentation	Dodatkowa zewnętrzna dokumentacja interfejsu API.
License	Informacje o licencji dla interfejsu API.
ManagedServiceIdentity	Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub przypisane przez użytkownika)
MetadataAssignment	Metadane przydziału
MetadataSchema	Jednostka schematu metadanych. Służy do definiowania metadanych dla jednostek w katalogu interfejsów API.
MetadataSchemaExportRequest	Żądanie eksportu schematu metadanych.
MetadataSchemaExportResult	Wynik eksportu schematu metadanych.
MetadataSchemaListResult	Odpowiedź operacji listy MetadataSchema.
MetadataSchemaProperties	Właściwości schematu metadanych.
MetadataSchemas	Interfejs reprezentujący metadaneSchemas.
MetadataSchemasCreateOrUpdateHeaders	Definiuje nagłówki dla operacji MetadataSchemas_createOrUpdate.
MetadataSchemasCreateOrUpdateOptionalParams	Parametry opcjonalne.
MetadataSchemasDeleteOptionalParams	Parametry opcjonalne.
MetadataSchemasGetHeaders	Definiuje nagłówki dla operacji MetadataSchemas_get.
MetadataSchemasGetOptionalParams	Parametry opcjonalne.
MetadataSchemasHeadOptionalParams	Parametry opcjonalne.
MetadataSchemasListNextOptionalParams	Parametry opcjonalne.
MetadataSchemasListOptionalParams	Parametry opcjonalne.
Onboarding	Informacje o dołączaniu
Operation	Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów
OperationDisplay	Zlokalizowane informacje o wyświetlaniu dla tej konkretnej operacji.
OperationListResult	Lista operacji interfejsu API REST obsługiwanych przez dostawcę zasobów platformy Azure. Zawiera link adresu URL umożliwiający pobranie następnego zestawu wyników.
Operations	Interfejs reprezentujący operacje.
OperationsListNextOptionalParams	Parametry opcjonalne.
OperationsListOptionalParams	Parametry opcjonalne.
ProxyResource	Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie zawierać tagów i lokalizacji
Resource	Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager
Service	Jednostka usługi.
ServiceListResult	Odpowiedź operacji listy usługi.
ServiceProperties	Właściwości usługi.
ServiceUpdate	Typ używany do operacji aktualizacji usługi.
Services	Interfejs reprezentujący usługi.
ServicesCreateOrUpdateOptionalParams	Parametry opcjonalne.
ServicesDeleteOptionalParams	Parametry opcjonalne.
ServicesExportMetadataSchemaHeaders	Definiuje nagłówki dla operacji Services_exportMetadataSchema.
ServicesExportMetadataSchemaOptionalParams	Parametry opcjonalne.
ServicesGetOptionalParams	Parametry opcjonalne.
ServicesListByResourceGroupNextOptionalParams	Parametry opcjonalne.
ServicesListByResourceGroupOptionalParams	Parametry opcjonalne.
ServicesListBySubscriptionNextOptionalParams	Parametry opcjonalne.
ServicesListBySubscriptionOptionalParams	Parametry opcjonalne.
ServicesUpdateOptionalParams	Parametry opcjonalne.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TermsOfService	Warunki użytkowania interfejsu API.
TrackedResource	Definicja modelu zasobów dla zasobu platformy Azure Resource Manager śledzony zasób najwyższego poziomu, który ma "tagi" i "lokalizację"
UserAssignedIdentity	Właściwości tożsamości przypisanej przez użytkownika
Workspace	Jednostka obszaru roboczego.
WorkspaceListResult	Odpowiedź operacji listy obszaru roboczego.
WorkspaceProperties	Właściwości obszaru roboczego.
Workspaces	Interfejs reprezentujący obszary robocze.
WorkspacesCreateOrUpdateHeaders	Definiuje nagłówki dla operacji Workspaces_createOrUpdate.
WorkspacesCreateOrUpdateOptionalParams	Parametry opcjonalne.
WorkspacesDeleteOptionalParams	Parametry opcjonalne.
WorkspacesGetHeaders	Definiuje nagłówki dla operacji Workspaces_get.
WorkspacesGetOptionalParams	Parametry opcjonalne.
WorkspacesHeadOptionalParams	Parametry opcjonalne.
WorkspacesListNextOptionalParams	Parametry opcjonalne.
WorkspacesListOptionalParams	Parametry opcjonalne.

Aliasy typu

ActionType	Definiuje wartości typu ActionType. Wartość KnownActionType może być używana zamiennie z elementem ActionType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Wewnętrzny
ApiDefinitionsCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Zawiera dane odpowiedzi dla operacji exportSpecification.
ApiDefinitionsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ApiDefinitionsHeadResponse	Zawiera dane odpowiedzi dla operacji głównej.
ApiDefinitionsListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
ApiDefinitionsListResponse	Zawiera dane odpowiedzi dla operacji listy.
ApiKind	Definiuje wartości dla interfejsu APIKind. ZnaneApiKind można używać zamiennie z interfejsem ApiKind. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę rest: Interfejs API transferu stanu reprezentacji graphql: interfejs API języka zapytań programu Graph grpc: interfejs API gRPC soap: interfejs API PROTOKOŁU SOAP element webhook: Web Hook websocket: Web Socket
ApiSpecExportResultFormat	Definiuje wartości dla elementu ApiSpecExportResultFormat. ZnaneApiSpecExportResultFormat można używać zamiennie z interfejsem APISpecExportResultFormat. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę śródwierszowa: podsycona zawartość dokumentu specyfikacji. link: link do wyniku operacji eksportu. Adres URL jest ważny przez 5 minut.
ApiSpecImportSourceFormat	Definiuje wartości elementu ApiSpecImportSourceFormat. ZnaneApiSpecImportSourceFormat można używać zamiennie z interfejsem APISpecImportSourceFormat. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę śródwierszowa: podsycona zawartość dokumentu specyfikacji. link: link do dokumentu specyfikacji hostowanego na publicznie dostępnym adresie internetowym.
ApiVersionsCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
ApiVersionsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ApiVersionsHeadResponse	Zawiera dane odpowiedzi dla operacji głównej.
ApiVersionsListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
ApiVersionsListResponse	Zawiera dane odpowiedzi dla operacji listy.
ApisCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
ApisGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ApisHeadResponse	Zawiera dane odpowiedzi dla operacji głównej.
ApisListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
ApisListResponse	Zawiera dane odpowiedzi dla operacji listy.
CreatedByType	Definiuje wartości dla właściwości CreatedByType. Funkcja KnownCreatedByType może być używana zamiennie z elementem CreatedByType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Użytkownik Aplikacja ManagedIdentity Klucz
DeploymentState	Definiuje wartości właściwości DeploymentState. Wartość KnownDeploymentState może być używana zamiennie z właściwością DeploymentState. Ta wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę aktywne: stan aktywny nieaktywny: stan nieaktywny
DeploymentsCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
DeploymentsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
DeploymentsHeadResponse	Zawiera dane odpowiedzi dla operacji head.
DeploymentsListNextResponse	Zawiera dane odpowiedzi dla operacji listNext.
DeploymentsListResponse	Zawiera dane odpowiedzi dla operacji listy.
EnvironmentKind	Definiuje wartości elementu EnvironmentKind. ZnaneEnvironmentKind można używać zamiennie z elementem EnvironmentKind. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę programowanie: środowisko deweloperskie testowanie: środowisko testowe przejściowe: środowisko przejściowe produkcja: środowisko produkcyjne
EnvironmentServerType	Definiuje wartości parametru EnvironmentServerType. ZnaneEnvironmentServerType można używać zamiennie z environmentServerType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Azure API Management: Api Management Server Usługa obliczeniowa platformy Azure: serwer obliczeniowy API Management Apigee: Serwer Apigee Brama interfejsu API platformy AWS: serwer bramy interfejsu API platformy AWS Kong API Gateway: Kong API Gateway server Kubernetes: serwer Kubernetes MuleSoft API Management: Mulesoft Api Management Server
EnvironmentsCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
EnvironmentsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
EnvironmentsHeadResponse	Zawiera dane odpowiedzi dla operacji head.
EnvironmentsListNextResponse	Zawiera dane odpowiedzi dla operacji listNext.
EnvironmentsListResponse	Zawiera dane odpowiedzi dla operacji listy.
LifecycleStage	Definiuje wartości elementu LifecycleStage. ZnaneLifecycleStage można używać zamiennie z cyklem życiaStage. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę projektowanie: etap projektowania programowanie: etap programowania testowanie: etap testowania wersja zapoznawcza: w wersji zapoznawczej produkcja: w środowisku produkcyjnym przestarzałe: przestarzały etap wycofano: Etap wycofany
ManagedServiceIdentityType	Definiuje wartości elementu ManagedServiceIdentityType. Wartość KnownManagedServiceIdentityType może być używana zamiennie z parametrem ManagedServiceIdentityType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Brak SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Definiuje wartości elementu MetadataAssignmentEntity. KnownMetadataAssignmentEntity można używać zamiennie z elementami MetadataAssignmentEntity. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę api: Przypisane do interfejsu API środowisko: przypisane do środowiska wdrożenie: przypisane do wdrożenia
MetadataSchemaExportFormat	Definiuje wartości dla metadataSchemaExportFormat. ZnaneMetadataSchemaExportFormat można używać zamiennie z elementem MetadataSchemaExportFormat. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę śródwierszowa: podsycona zawartość dokumentu schematu. link: link do dokumentu schematu. Adres URL jest ważny przez 5 minut.
MetadataSchemasCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
MetadataSchemasGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
MetadataSchemasHeadResponse	Zawiera dane odpowiedzi dla operacji głównej.
MetadataSchemasListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
MetadataSchemasListResponse	Zawiera dane odpowiedzi dla operacji listy.
OperationsListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
OperationsListResponse	Zawiera dane odpowiedzi dla operacji listy.
Origin	Definiuje wartości źródła. ZnaneOrigin może być używane zamiennie z origin, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę użytkownik system użytkownik,system
ProvisioningState	Definiuje wartości provisioningState. ZnaneProvisioningState można używać zamiennie z provisioningState, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Powodzenie: zasób został utworzony. Niepowodzenie: tworzenie zasobu nie powiodło się. Anulowano: Tworzenie zasobów zostało anulowane.
ServicesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
ServicesExportMetadataSchemaResponse	Zawiera dane odpowiedzi dla operacji exportMetadataSchema.
ServicesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ServicesListByResourceGroupNextResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroupNext.
ServicesListByResourceGroupResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroup.
ServicesListBySubscriptionNextResponse	Zawiera dane odpowiedzi dla operacji listBySubscriptionNext.
ServicesListBySubscriptionResponse	Zawiera dane odpowiedzi dla operacji listBySubscription.
ServicesUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
Versions	Definiuje wartości dla wersji. Funkcja KnownVersions może być używana zamiennie z wersjami. Ta wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę 2024-03-01: Początkowa wersja usługi
WorkspacesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
WorkspacesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
WorkspacesHeadResponse	Zawiera dane odpowiedzi dla operacji głównej.
WorkspacesListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
WorkspacesListResponse	Zawiera dane odpowiedzi dla operacji listy.

Wyliczenia

KnownActionType	Znane wartości ActionType akceptowane przez usługę.
KnownApiKind	Znane wartości apiKind akceptowane przez usługę.
KnownApiSpecExportResultFormat	Znane wartości apiSpecExportResultFormat akceptowane przez usługę.
KnownApiSpecImportSourceFormat	Znane wartości apiSpecImportSourceFormat akceptowane przez usługę.
KnownCreatedByType	Znane wartości CreatedByType akceptowane przez usługę.
KnownDeploymentState	Znane wartości właściwości DeploymentState akceptowane przez usługę.
KnownEnvironmentKind	Znane wartości environmentKind akceptowane przez usługę.
KnownEnvironmentServerType	Znane wartości EnvironmentServerType akceptowane przez usługę.
KnownLifecycleStage	Znane wartości LifecycleStage akceptowane przez usługę.
KnownManagedServiceIdentityType	Znane wartości ManagedServiceIdentityType akceptowane przez usługę.
KnownMetadataAssignmentEntity	Znane wartości MetadataAssignmentEntity akceptowane przez usługę.
KnownMetadataSchemaExportFormat	Znane wartości MetadataSchemaExportFormat akceptowane przez usługę.
KnownOrigin	Znane wartości źródła , które akceptuje usługa.
KnownProvisioningState	Znane wartości parametru ProvisioningState akceptowane przez usługę.
KnownVersions	Znane wartości wersji akceptowanych przez usługę.

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

Szczegóły funkcji

getContinuationToken(unknown)

Biorąc pod uwagę ostatni .value wygenerowany przez byPage iterator, 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 value dostępu do iteratoraresult z iteratora byPage .

Zwraca

string | undefined

Token kontynuacji, który można przekazać do elementu byPage() podczas przyszłych wywołań.