@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 Kopfzeilen für ApiDefinitions_createOrUpdate Vorgang.
ApiDefinitionsCreateOrUpdateOptionalParams	Optionale Parameter.
ApiDefinitionsDeleteOptionalParams	Optionale Parameter.
ApiDefinitionsExportSpecificationHeaders	Definiert Kopfzeilen für ApiDefinitions_exportSpecification Vorgang.
ApiDefinitionsExportSpecificationOptionalParams	Optionale Parameter.
ApiDefinitionsGetHeaders	Definiert Kopfzeilen für ApiDefinitions_get Vorgang.
ApiDefinitionsGetOptionalParams	Optionale Parameter.
ApiDefinitionsHeadOptionalParams	Optionale Parameter.
ApiDefinitionsImportSpecificationHeaders	Definiert Kopfzeilen 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	Die Eigenschaften der QUELLentität 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 Kopfzeilen für ApiVersions_createOrUpdate Vorgang.
ApiVersionsCreateOrUpdateOptionalParams	Optionale Parameter.
ApiVersionsDeleteOptionalParams	Optionale Parameter.
ApiVersionsGetHeaders	Definiert Kopfzeilen für ApiVersions_get Vorgang.
ApiVersionsGetOptionalParams	Optionale Parameter.
ApiVersionsHeadOptionalParams	Optionale Parameter.
ApiVersionsListNextOptionalParams	Optionale Parameter.
ApiVersionsListOptionalParams	Optionale Parameter.
Apis	Schnittstelle, die eine API darstellt.
ApisCreateOrUpdateHeaders	Definiert Kopfzeilen für Apis_createOrUpdate Vorgang.
ApisCreateOrUpdateOptionalParams	Optionale Parameter.
ApisDeleteOptionalParams	Optionale Parameter.
ApisGetHeaders	Definiert Kopfzeilen 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 Kopfzeilen für Deployments_createOrUpdate Vorgang.
DeploymentsCreateOrUpdateOptionalParams	Optionale Parameter.
DeploymentsDeleteOptionalParams	Optionale Parameter.
DeploymentsGetHeaders	Definiert Kopfzeilen 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	Entität der Umgebungseigenschaften.
EnvironmentServer	Serverinformationen der Umgebung.
Environments	Schnittstelle, die eine Umgebung darstellt.
EnvironmentsCreateOrUpdateHeaders	Definiert Kopfzeilen für Environments_createOrUpdate Vorgang.
EnvironmentsCreateOrUpdateOptionalParams	Optionale Parameter.
EnvironmentsDeleteOptionalParams	Optionale Parameter.
EnvironmentsGetHeaders	Definiert Kopfzeilen für Environments_get Vorgang.
EnvironmentsGetOptionalParams	Optionale Parameter.
EnvironmentsHeadOptionalParams	Optionale Parameter.
EnvironmentsListNextOptionalParams	Optionale Parameter.
EnvironmentsListOptionalParams	Optionale Parameter.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (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 (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
MetadataAssignment	Zuordnungsmetadaten
MetadataSchema	Metadatenschemaentität. Wird verwendet, um Metadaten für die Entitäten im API-Katalog zu definieren.
MetadataSchemaExportRequest	Die Metadatenschemaexportanforderung.
MetadataSchemaExportResult	Das Metadatenschemaexportergebnis.
MetadataSchemaListResult	Die Antwort eines MetadataSchema-Listenvorgangs.
MetadataSchemaProperties	Metadatenschemaeigenschaften.
MetadataSchemas	Schnittstelle, die ein MetadataSchemas darstellt.
MetadataSchemasCreateOrUpdateHeaders	Definiert Kopfzeilen für MetadataSchemas_createOrUpdate Vorgang.
MetadataSchemasCreateOrUpdateOptionalParams	Optionale Parameter.
MetadataSchemasDeleteOptionalParams	Optionale Parameter.
MetadataSchemasGetHeaders	Definiert Kopfzeilen für MetadataSchemas_get Vorgang.
MetadataSchemasGetOptionalParams	Optionale Parameter.
MetadataSchemasHeadOptionalParams	Optionale Parameter.
MetadataSchemasListNextOptionalParams	Optionale Parameter.
MetadataSchemasListOptionalParams	Optionale Parameter.
Onboarding	Onboarding-Informationen
Operation	Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-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 eine Operation darstellt.
OperationsListNextOptionalParams	Optionale Parameter.
OperationsListOptionalParams	Optionale Parameter.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine 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 Kopfzeilen 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 zur Erstellung und letzten Änderung der Ressource.
TermsOfService	Nutzungsbedingungen für die API.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften
Workspace	Arbeitsbereichsentität.
WorkspaceListResult	Die Antwort eines Arbeitsbereichslistenvorgangs.
WorkspaceProperties	Arbeitsbereichseigenschaften.
Workspaces	Schnittstelle, die einen Arbeitsbereich darstellt.
WorkspacesCreateOrUpdateHeaders	Definiert Kopfzeilen für Workspaces_createOrUpdate Vorgang.
WorkspacesCreateOrUpdateOptionalParams	Optionale Parameter.
WorkspacesDeleteOptionalParams	Optionale Parameter.
WorkspacesGetHeaders	Definiert Kopfzeilen 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- austauschbar mit ActionType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden internen
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 Head-Vorgang.
ApiDefinitionsListNextResponse	Enthält Antwortdaten für den listNext-Vorgang.
ApiDefinitionsListResponse	Enthält Antwortdaten für den Listenvorgang.
ApiKind	Definiert Werte für ApiKind. KnownApiKind- austauschbar mit ApiKind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden rest: Eine Representational State Transfer API graphql-: Eine Graph-Abfragesprache-API grpc: Eine gRPC-Api Soap-: Eine SOAP-API Webhook-: Web hook websocket: Web Socket
ApiSpecExportResultFormat	Definiert Werte für ApiSpecExportResultFormat. KnownApiSpecExportResultFormat austauschbar mit ApiSpecExportResultFormat verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden inline: Der inlineierte Inhalt eines Spezifikationsdokuments. Link: Der Link zum Ergebnis des Exportvorgangs. Die URL ist 5 Minuten gültig.
ApiSpecImportSourceFormat	Definiert Werte für ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat austauschbar mit ApiSpecImportSourceFormat verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden inline: Der inlineierte 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 Head-Vorgang.
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 Head-Vorgang.
ApisListNextResponse	Enthält Antwortdaten für den listNext-Vorgang.
ApisListResponse	Enthält Antwortdaten für den Listenvorgang.
CreatedByType	Definiert Werte für CreatedByType. KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Application ManagedIdentity- Key-
DeploymentState	Definiert Werte für DeploymentState. KnownDeploymentState- austauschbar mit DeploymentState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden aktive: Aktiver Status inaktive: 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 Head-Vorgang.
DeploymentsListNextResponse	Enthält Antwortdaten für den listNext-Vorgang.
DeploymentsListResponse	Enthält Antwortdaten für den Listenvorgang.
EnvironmentKind	Definiert Werte für EnvironmentKind. KnownEnvironmentKind austauschbar mit EnvironmentKind verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Entwicklung: Entwicklungsumgebung Testen: Testumgebung Staging-: Stagingumgebung Produktionsumgebung: Produktionsumgebung
EnvironmentServerType	Definiert Werte für EnvironmentServerType. KnownEnvironmentServerType austauschbar mit EnvironmentServerType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Azure API Management: Api Management Server Azure-Computedienst: Computeserver Apigee-API-Verwaltung: Apigee-Server AWS-API-Gateway-: AWS Api Gateway-Server Kong-API-Gateway-: Kong-API-Gatewayserver 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 Head-Vorgang.
EnvironmentsListNextResponse	Enthält Antwortdaten für den listNext-Vorgang.
EnvironmentsListResponse	Enthält Antwortdaten für den Listenvorgang.
LifecycleStage	Definiert Werte für LifecycleStage. KnownLifecycleStage- austauschbar mit LifecycleStage verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Design-: Entwurfsphase Entwicklung: Entwicklungsphase test: Testphase Vorschau-: In der Vorschau Produktion: In der Produktion veraltete: veraltete Stufe eingestellte: Eingestellte Phase
ManagedServiceIdentityType	Definiert Werte für ManagedServiceIdentityType. KnownManagedServiceIdentityType austauschbar mit ManagedServiceIdentityType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Keine SystemAssigned- UserAssigned- SystemAssigned,UserAssigned
MetadataAssignmentEntity	Definiert Werte für MetadataAssignmentEntity. KnownMetadataAssignmentEntity austauschbar mit MetadataAssignmentEntity verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden -API-: Api zugewiesen Umgebung: Zugewiesen an Die Umgebung Bereitstellungs-: Bereitstellung zugewiesen
MetadataSchemaExportFormat	Definiert Werte für MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat austauschbar mit MetadataSchemaExportFormat verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Inline-: Der inlineierte Inhalt eines Schemadokuments. Link: Der Link zu einem Schemadokument. Die URL ist 5 Minuten 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 Head-Vorgang.
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 austauschbar mit Origin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden System- Benutzer,System-
ProvisioningState	Definiert Werte für ProvisioningState. KnownProvisioningState austauschbar mit ProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Erfolgreich: Ressource wurde erstellt. Fehlgeschlagene: Fehler bei der Ressourcenerstellung. Abgebrochene: 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- austauschbar mit Versionen verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden 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 Head-Vorgang.
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 Werte von Origin, 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)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt vom Zugriff auf value im IteratorResult aus einem byPage Iterator.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das während zukünftiger Aufrufe an byPage() übergeben werden kann.