@azure/arm-apicenter package

Klassen

AzureAPICenter

Schnittstellen

Api	API-Entität.
ApiDefinition	API-Definitionsentität.
ApiDefinitionListResult	Die Antwort eines ApiDefinition-Listenvorgangs.
ApiDefinitionProperties	Entität der API-Definitionseigenschaften.
ApiDefinitionPropertiesSpecification	API-Spezifikationsdetails.
ApiDefinitions	Schnittstelle, die eine ApiDefinitions darstellt.
ApiDefinitionsCreateOrUpdateHeaders	Definiert Header für ApiDefinitions_createOrUpdate Vorgang.
ApiDefinitionsCreateOrUpdateOptionalParams	Optionale Parameter.
ApiDefinitionsDeleteOptionalParams	Optionale Parameter.
ApiDefinitionsExportSpecificationHeaders	Definiert Header für ApiDefinitions_exportSpecification Vorgang.
ApiDefinitionsExportSpecificationOptionalParams	Optionale Parameter.
ApiDefinitionsGetHeaders	Definiert Header für ApiDefinitions_get Vorgang.
ApiDefinitionsGetOptionalParams	Optionale Parameter.
ApiDefinitionsHeadOptionalParams	Optionale Parameter.
ApiDefinitionsImportSpecificationHeaders	Definiert Header für ApiDefinitions_importSpecification Vorgang.
ApiDefinitionsImportSpecificationOptionalParams	Optionale Parameter.
ApiDefinitionsListNextOptionalParams	Optionale Parameter.
ApiDefinitionsListOptionalParams	Optionale Parameter.
ApiListResult	Die Antwort eines API-Listenvorgangs.
ApiProperties	API-Eigenschaften.
ApiSpecExportResult	Das Exportergebnis der API-Spezifikation.
ApiSpecImportRequest	Quellentitätseigenschaften der API-Spezifikation.
ApiSpecImportRequestSpecification	API-Spezifikationsdetails.
ApiVersion	API-Versionsentität.
ApiVersionListResult	Die Antwort eines ApiVersion-Listenvorgangs.
ApiVersionProperties	Entität der API-Versionseigenschaften.
ApiVersions	Schnittstelle, die eine ApiVersions darstellt.
ApiVersionsCreateOrUpdateHeaders	Definiert Header für ApiVersions_createOrUpdate Vorgang.
ApiVersionsCreateOrUpdateOptionalParams	Optionale Parameter.
ApiVersionsDeleteOptionalParams	Optionale Parameter.
ApiVersionsGetHeaders	Definiert Header für ApiVersions_get Vorgang.
ApiVersionsGetOptionalParams	Optionale Parameter.
ApiVersionsHeadOptionalParams	Optionale Parameter.
ApiVersionsListNextOptionalParams	Optionale Parameter.
ApiVersionsListOptionalParams	Optionale Parameter.
Apis	Schnittstelle, die eine Apis darstellt.
ApisCreateOrUpdateHeaders	Definiert Header für Apis_createOrUpdate Vorgang.
ApisCreateOrUpdateOptionalParams	Optionale Parameter.
ApisDeleteOptionalParams	Optionale Parameter.
ApisGetHeaders	Definiert Header für Apis_get Vorgang.
ApisGetOptionalParams	Optionale Parameter.
ApisHeadOptionalParams	Optionale Parameter.
ApisListNextOptionalParams	Optionale Parameter.
ApisListOptionalParams	Optionale Parameter.
AzureAPICenterOptionalParams	Optionale Parameter.
Contact	Kontaktinformationen
Deployment	API-Bereitstellungsentität.
DeploymentListResult	Die Antwort eines Bereitstellungslistenvorgangs.
DeploymentProperties	Eigenschaften der API-Bereitstellungsentität.
DeploymentServer	Server
Deployments	Schnittstelle, die eine Bereitstellung darstellt.
DeploymentsCreateOrUpdateHeaders	Definiert Header für Deployments_createOrUpdate Vorgang.
DeploymentsCreateOrUpdateOptionalParams	Optionale Parameter.
DeploymentsDeleteOptionalParams	Optionale Parameter.
DeploymentsGetHeaders	Definiert Header für Deployments_get Vorgang.
DeploymentsGetOptionalParams	Optionale Parameter.
DeploymentsHeadOptionalParams	Optionale Parameter.
DeploymentsListNextOptionalParams	Optionale Parameter.
DeploymentsListOptionalParams	Optionale Parameter.
Environment	Umgebungsentität.
EnvironmentListResult	Die Antwort eines Umgebungslistenvorgangs.
EnvironmentProperties	Umgebungseigenschaftenentität.
EnvironmentServer	Serverinformationen der Umgebung.
Environments	Schnittstelle, die eine Umgebung darstellt.
EnvironmentsCreateOrUpdateHeaders	Definiert Header für Environments_createOrUpdate Vorgang.
EnvironmentsCreateOrUpdateOptionalParams	Optionale Parameter.
EnvironmentsDeleteOptionalParams	Optionale Parameter.
EnvironmentsGetHeaders	Definiert Header für Environments_get Vorgang.
EnvironmentsGetOptionalParams	Optionale Parameter.
EnvironmentsHeadOptionalParams	Optionale Parameter.
EnvironmentsListNextOptionalParams	Optionale Parameter.
EnvironmentsListOptionalParams	Optionale Parameter.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.).
ExternalDocumentation	Zusätzliche externe Dokumentation für die API.
License	Die Lizenzinformationen für die API.
ManagedServiceIdentity	Verwaltete Dienstidentität (systemseitig zugewiesene und/oder benutzerseitig zugewiesene Identitäten)
MetadataAssignment	Zuweisungsmetadaten
MetadataSchema	Metadatenschemaentität. Wird verwendet, um Metadaten für die Entitäten im API-Katalog zu definieren.
MetadataSchemaExportRequest	Die Exportanforderung für das Metadatenschema.
MetadataSchemaExportResult	Das Ergebnis des Metadatenschemaexports.
MetadataSchemaListResult	Die Antwort eines MetadataSchema-Listenvorgangs.
MetadataSchemaProperties	Metadatenschemaeigenschaften.
MetadataSchemas	Schnittstelle, die ein MetadataSchemas darstellt.
MetadataSchemasCreateOrUpdateHeaders	Definiert Header für MetadataSchemas_createOrUpdate Vorgang.
MetadataSchemasCreateOrUpdateOptionalParams	Optionale Parameter.
MetadataSchemasDeleteOptionalParams	Optionale Parameter.
MetadataSchemasGetHeaders	Definiert Header für MetadataSchemas_get Vorgang.
MetadataSchemasGetOptionalParams	Optionale Parameter.
MetadataSchemasHeadOptionalParams	Optionale Parameter.
MetadataSchemasListNextOptionalParams	Optionale Parameter.
MetadataSchemasListOptionalParams	Optionale Parameter.
Onboarding	Onboardinginformationen
Operation	Details eines REST-API-Vorgangs, der von der Ressourcenanbieterbetriebs-API zurückgegeben wird
OperationDisplay	Lokalisierte Anzeigeinformationen für diesen bestimmten Vorgang.
OperationListResult	Eine Liste der REST-API-Vorgänge, die von einem Azure-Ressourcenanbieter unterstützt werden. Sie enthält einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.
Operations	Schnittstelle, die einen Vorgang darstellt.
OperationsListNextOptionalParams	Optionale Parameter.
OperationsListOptionalParams	Optionale Parameter.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es verfügt nicht über Tags und einen Speicherort.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
Service	Die Dienstentität.
ServiceListResult	Die Antwort eines Dienstlistenvorgangs.
ServiceProperties	Die Eigenschaften des Diensts.
ServiceUpdate	Der Typ, der für Aktualisierungsvorgänge des Diensts verwendet wird.
Services	Schnittstelle, die einen Dienst darstellt.
ServicesCreateOrUpdateOptionalParams	Optionale Parameter.
ServicesDeleteOptionalParams	Optionale Parameter.
ServicesExportMetadataSchemaHeaders	Definiert Header für Services_exportMetadataSchema Vorgang.
ServicesExportMetadataSchemaOptionalParams	Optionale Parameter.
ServicesGetOptionalParams	Optionale Parameter.
ServicesListByResourceGroupNextOptionalParams	Optionale Parameter.
ServicesListByResourceGroupOptionalParams	Optionale Parameter.
ServicesListBySubscriptionNextOptionalParams	Optionale Parameter.
ServicesListBySubscriptionOptionalParams	Optionale Parameter.
ServicesUpdateOptionalParams	Optionale Parameter.
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TermsOfService	Nutzungsbedingungen für die API.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure-Resource Manager nachverfolgte Ressource der obersten Ebene mit "Tags" und einem "Standort"
UserAssignedIdentity	Benutzerseitig zugewiesene Identitätseigenschaften
Workspace	Arbeitsbereichsentität.
WorkspaceListResult	Die Antwort eines Arbeitsbereichslistenvorgangs.
WorkspaceProperties	Arbeitsbereichseigenschaften.
Workspaces	Schnittstelle, die einen Arbeitsbereich darstellt.
WorkspacesCreateOrUpdateHeaders	Definiert Header für Workspaces_createOrUpdate Vorgang.
WorkspacesCreateOrUpdateOptionalParams	Optionale Parameter.
WorkspacesDeleteOptionalParams	Optionale Parameter.
WorkspacesGetHeaders	Definiert Header für Workspaces_get Vorgang.
WorkspacesGetOptionalParams	Optionale Parameter.
WorkspacesHeadOptionalParams	Optionale Parameter.
WorkspacesListNextOptionalParams	Optionale Parameter.
WorkspacesListOptionalParams	Optionale Parameter.

Typaliase

ActionType	Definiert Werte für ActionType. KnownActionType kann austauschbar mit ActionType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Intern
ApiDefinitionsCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
ApiDefinitionsExportSpecificationResponse	Enthält Antwortdaten für den exportSpecification-Vorgang.
ApiDefinitionsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ApiDefinitionsHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
ApiDefinitionsListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
ApiDefinitionsListResponse	Enthält Antwortdaten für den Listenvorgang.
ApiKind	Definiert Werte für ApiKind. KnownApiKind kann austauschbar mit ApiKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte rest: Eine Api für die Übertragung von Repräsentationszuständen graphql: Eine Graph-Abfragesprache-Api grpc: Eine gRPC-Api soap: Eine SOAP-Api Webhook: Web Hook websocket: Websocket: Websocket
ApiSpecExportResultFormat	Definiert Werte für ApiSpecExportResultFormat. KnownApiSpecExportResultFormat kann austauschbar mit ApiSpecExportResultFormat verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte inline: Der inline enthaltene Inhalt eines Spezifikationsdokuments. link: Der Link zum Ergebnis des Exportvorgangs. Die URL ist 5 Minuten lang gültig.
ApiSpecImportSourceFormat	Definiert Werte für ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat kann austauschbar mit ApiSpecImportSourceFormat verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte inline: Der inline enthaltene Inhalt eines Spezifikationsdokuments. Link: Der Link zu einem Spezifikationsdokument, das auf einer öffentlich zugänglichen Internetadresse gehostet wird.
ApiVersionsCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
ApiVersionsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ApiVersionsHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
ApiVersionsListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
ApiVersionsListResponse	Enthält Antwortdaten für den Listenvorgang.
ApisCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
ApisGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ApisHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
ApisListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
ApisListResponse	Enthält Antwortdaten für den Listenvorgang.
CreatedByType	Definiert Werte für CreatedByType. KnownCreatedByType kann austauschbar mit CreatedByType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Benutzer Anwendung ManagedIdentity Schlüssel
DeploymentState	Definiert Werte für DeploymentState. KnownDeploymentState kann austauschbar mit DeploymentState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte aktiv: Aktivzustand inaktiv: Inaktiver Zustand
DeploymentsCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
DeploymentsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
DeploymentsHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
DeploymentsListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
DeploymentsListResponse	Enthält Antwortdaten für den Listenvorgang.
EnvironmentKind	Definiert Werte für EnvironmentKind. KnownEnvironmentKind kann austauschbar mit EnvironmentKind verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Entwicklung: Entwicklungsumgebung Testen: Testumgebung Staging: Stagingumgebung Produktion: Produktionsumgebung
EnvironmentServerType	Definiert Werte für EnvironmentServerType. KnownEnvironmentServerType kann austauschbar mit EnvironmentServerType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Azure API Management: Api Management Server Azure-Computedienst: Computeserver Apigee API Management: Apigee-Server AWS API Gateway: AWS Api Gateway-Server Kong API Gateway: Kong API Gateway-Server Kubernetes: Kubernetes-Server MuleSoft API Management: Mulesoft Api Management-Server
EnvironmentsCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
EnvironmentsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
EnvironmentsHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
EnvironmentsListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
EnvironmentsListResponse	Enthält Antwortdaten für den Listenvorgang.
LifecycleStage	Definiert Werte für LifecycleStage. KnownLifecycleStage kann austauschbar mit LifecycleStage verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Entwurf: Entwurfsphase Entwicklung: Entwicklungsphase Testen: Testphase Vorschau: In der Vorschau Produktion: In der Produktion veraltet: veraltete Phase ausgemustert: Phase aus dem Ruhestand
ManagedServiceIdentityType	Definiert Werte für ManagedServiceIdentityType. KnownManagedServiceIdentityType kann austauschbar mit ManagedServiceIdentityType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte None SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Definiert Werte für MetadataAssignmentEntity. KnownMetadataAssignmentEntity kann austauschbar mit MetadataAssignmentEntity verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte api: API zugewiesen Umgebung: Der Umgebung zugewiesen Bereitstellung: Bereitstellung zugewiesen
MetadataSchemaExportFormat	Definiert Werte für MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat kann austauschbar mit MetadataSchemaExportFormat verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte inline: Der inline enthaltene Inhalt eines Schemadokuments. link: Der Link zu einem Schemadokument. Die URL ist 5 Minuten lang gültig.
MetadataSchemasCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
MetadataSchemasGetResponse	Enthält Antwortdaten für den Get-Vorgang.
MetadataSchemasHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
MetadataSchemasListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
MetadataSchemasListResponse	Enthält Antwortdaten für den Listenvorgang.
OperationsListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
OperationsListResponse	Enthält Antwortdaten für den Listenvorgang.
Origin	Definiert Werte für Origin. KnownOrigin kann austauschbar mit Origin verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte user System Benutzer,System
ProvisioningState	Definiert Werte für ProvisioningState. KnownProvisioningState kann austauschbar mit ProvisioningState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte Erfolgreich: Ressource wurde erstellt. Fehler: Fehler bei der Ressourcenerstellung. Abgebrochen: Die Ressourcenerstellung wurde abgebrochen.
ServicesCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
ServicesExportMetadataSchemaResponse	Enthält Antwortdaten für den exportMetadataSchema-Vorgang.
ServicesGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ServicesListByResourceGroupNextResponse	Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang.
ServicesListByResourceGroupResponse	Enthält Antwortdaten für den ListByResourceGroup-Vorgang.
ServicesListBySubscriptionNextResponse	Enthält Antwortdaten für den ListBySubscriptionNext-Vorgang.
ServicesListBySubscriptionResponse	Enthält Antwortdaten für den ListBySubscription-Vorgang.
ServicesUpdateResponse	Enthält Antwortdaten für den Aktualisierungsvorgang.
Versions	Definiert Werte für Versionen. KnownVersions kann austauschbar mit Versionen verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Vom Dienst unterstützte bekannte Werte 2024-03-01: Die erste Dienstversion
WorkspacesCreateOrUpdateResponse	Enthält Antwortdaten für den CreateOrUpdate-Vorgang.
WorkspacesGetResponse	Enthält Antwortdaten für den Get-Vorgang.
WorkspacesHeadResponse	Enthält Antwortdaten für den Hauptvorgang.
WorkspacesListNextResponse	Enthält Antwortdaten für den ListNext-Vorgang.
WorkspacesListResponse	Enthält Antwortdaten für den Listenvorgang.

Enumerationen

KnownActionType	Bekannte Werte von ActionType , die der Dienst akzeptiert.
KnownApiKind	Bekannte Werte von ApiKind , die der Dienst akzeptiert.
KnownApiSpecExportResultFormat	Bekannte Werte von ApiSpecExportResultFormat , die der Dienst akzeptiert.
KnownApiSpecImportSourceFormat	Bekannte Werte von ApiSpecImportSourceFormat , die der Dienst akzeptiert.
KnownCreatedByType	Bekannte Werte von CreatedByType , die der Dienst akzeptiert.
KnownDeploymentState	Bekannte Werte von DeploymentState , die der Dienst akzeptiert.
KnownEnvironmentKind	Bekannte Werte von EnvironmentKind , die der Dienst akzeptiert.
KnownEnvironmentServerType	Bekannte Werte von EnvironmentServerType , die der Dienst akzeptiert.
KnownLifecycleStage	Bekannte Werte von LifecycleStage , die der Dienst akzeptiert.
KnownManagedServiceIdentityType	Bekannte Werte von ManagedServiceIdentityType , die der Dienst akzeptiert.
KnownMetadataAssignmentEntity	Bekannte Werte von MetadataAssignmentEntity , die der Dienst akzeptiert.
KnownMetadataSchemaExportFormat	Bekannte Werte von MetadataSchemaExportFormat , die der Dienst akzeptiert.
KnownOrigin	Bekannte Ursprungswerte , die der Dienst akzeptiert.
KnownProvisioningState	Bekannte Werte von ProvisioningState , die der Dienst akzeptiert.
KnownVersions	Bekannte Werte von Versionen , die der Dienst akzeptiert.

Functions

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt, das von einem byPage Iterator auf iteratorResult zugreiftvalue.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.