@azure/arm-apicenter package

Třídy

AzureAPICenter

Rozhraní

Api	Entita rozhraní API
ApiDefinition	Entita definice rozhraní API
ApiDefinitionListResult	Odpověď operace seznamu ApiDefinition.
ApiDefinitionProperties	Entita vlastností definice rozhraní API
ApiDefinitionPropertiesSpecification	Podrobnosti specifikace rozhraní API
ApiDefinitions	Rozhraní představující apiDefinitions
ApiDefinitionsCreateOrUpdateHeaders	Definuje hlavičky pro operaci ApiDefinitions_createOrUpdate.
ApiDefinitionsCreateOrUpdateOptionalParams	Volitelné parametry.
ApiDefinitionsDeleteOptionalParams	Volitelné parametry.
ApiDefinitionsExportSpecificationHeaders	Definuje hlavičky pro operaci ApiDefinitions_exportSpecification.
ApiDefinitionsExportSpecificationOptionalParams	Volitelné parametry.
ApiDefinitionsGetHeaders	Definuje hlavičky pro operaci ApiDefinitions_get.
ApiDefinitionsGetOptionalParams	Volitelné parametry.
ApiDefinitionsHeadOptionalParams	Volitelné parametry.
ApiDefinitionsImportSpecificationHeaders	Definuje hlavičky pro operaci ApiDefinitions_importSpecification.
ApiDefinitionsImportSpecificationOptionalParams	Volitelné parametry.
ApiDefinitionsListNextOptionalParams	Volitelné parametry.
ApiDefinitionsListOptionalParams	Volitelné parametry.
ApiListResult	Odpověď operace seznamu rozhraní API.
ApiProperties	Vlastnosti rozhraní API.
ApiSpecExportResult	Výsledek exportu specifikace rozhraní API
ApiSpecImportRequest	Vlastnosti zdrojové entity specifikace rozhraní API.
ApiSpecImportRequestSpecification	Podrobnosti specifikace rozhraní API
ApiVersion	Entita verze rozhraní API
ApiVersionListResult	Odpověď operace seznamu ApiVersion.
ApiVersionProperties	Entita vlastností verze rozhraní API
ApiVersions	Rozhraní představující rozhraní ApiVersions.
ApiVersionsCreateOrUpdateHeaders	Definuje hlavičky pro operaci ApiVersions_createOrUpdate.
ApiVersionsCreateOrUpdateOptionalParams	Volitelné parametry.
ApiVersionsDeleteOptionalParams	Volitelné parametry.
ApiVersionsGetHeaders	Definuje hlavičky pro operaci ApiVersions_get.
ApiVersionsGetOptionalParams	Volitelné parametry.
ApiVersionsHeadOptionalParams	Volitelné parametry.
ApiVersionsListNextOptionalParams	Volitelné parametry.
ApiVersionsListOptionalParams	Volitelné parametry.
Apis	Rozhraní představující rozhraní APIS
ApisCreateOrUpdateHeaders	Definuje hlavičky pro operaci Apis_createOrUpdate.
ApisCreateOrUpdateOptionalParams	Volitelné parametry.
ApisDeleteOptionalParams	Volitelné parametry.
ApisGetHeaders	Definuje hlavičky pro operaci Apis_get.
ApisGetOptionalParams	Volitelné parametry.
ApisHeadOptionalParams	Volitelné parametry.
ApisListNextOptionalParams	Volitelné parametry.
ApisListOptionalParams	Volitelné parametry.
AzureAPICenterOptionalParams	Volitelné parametry.
Contact	Kontaktní informace
Deployment	Entita nasazení rozhraní API
DeploymentListResult	Odpověď operace seznamu nasazení.
DeploymentProperties	Vlastnosti entity nasazení rozhraní API
DeploymentServer	Server
Deployments	Rozhraní představující nasazení
DeploymentsCreateOrUpdateHeaders	Definuje hlavičky pro operaci Deployments_createOrUpdate.
DeploymentsCreateOrUpdateOptionalParams	Volitelné parametry.
DeploymentsDeleteOptionalParams	Volitelné parametry.
DeploymentsGetHeaders	Definuje hlavičky pro operaci Deployments_get.
DeploymentsGetOptionalParams	Volitelné parametry.
DeploymentsHeadOptionalParams	Volitelné parametry.
DeploymentsListNextOptionalParams	Volitelné parametry.
DeploymentsListOptionalParams	Volitelné parametry.
Environment	Entita prostředí.
EnvironmentListResult	Odpověď operace seznamu prostředí.
EnvironmentProperties	Entita vlastností prostředí
EnvironmentServer	Informace o serveru prostředí.
Environments	Rozhraní představující prostředí
EnvironmentsCreateOrUpdateHeaders	Definuje hlavičky pro operaci Environments_createOrUpdate.
EnvironmentsCreateOrUpdateOptionalParams	Volitelné parametry.
EnvironmentsDeleteOptionalParams	Volitelné parametry.
EnvironmentsGetHeaders	Definuje hlavičky pro operaci Environments_get.
EnvironmentsGetOptionalParams	Volitelné parametry.
EnvironmentsHeadOptionalParams	Volitelné parametry.
EnvironmentsListNextOptionalParams	Volitelné parametry.
EnvironmentsListOptionalParams	Volitelné parametry.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
ExternalDocumentation	Další externí dokumentace k rozhraní API
License	Informace o licenci pro rozhraní API.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
MetadataAssignment	Metadata přiřazení
MetadataSchema	Entita schématu metadat. Slouží k definování metadat pro entity v katalogu rozhraní API.
MetadataSchemaExportRequest	Požadavek na export schématu metadat.
MetadataSchemaExportResult	Výsledek exportu schématu metadat.
MetadataSchemaListResult	Odpověď operace seznamu MetadataSchema.
MetadataSchemaProperties	Vlastnosti schématu metadat.
MetadataSchemas	Rozhraní představující metadataSchemas.
MetadataSchemasCreateOrUpdateHeaders	Definuje hlavičky pro operaci MetadataSchemas_createOrUpdate.
MetadataSchemasCreateOrUpdateOptionalParams	Volitelné parametry.
MetadataSchemasDeleteOptionalParams	Volitelné parametry.
MetadataSchemasGetHeaders	Definuje hlavičky pro operaci MetadataSchemas_get.
MetadataSchemasGetOptionalParams	Volitelné parametry.
MetadataSchemasHeadOptionalParams	Volitelné parametry.
MetadataSchemasListNextOptionalParams	Volitelné parametry.
MetadataSchemasListOptionalParams	Volitelné parametry.
Onboarding	Informace o onboardingu
Operation	Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků
OperationDisplay	Lokalizované informace o zobrazení pro tuto konkrétní operaci
OperationListResult	Seznam operací REST API podporovaných poskytovatelem prostředků Azure Obsahuje odkaz na adresu URL pro získání další sady výsledků.
Operations	Rozhraní představující operace
OperationsListNextOptionalParams	Volitelné parametry.
OperationsListOptionalParams	Volitelné parametry.
ProxyResource	Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.
Resource	Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru
Service	Entita služby.
ServiceListResult	Odpověď operace seznamu služeb.
ServiceProperties	Vlastnosti služby.
ServiceUpdate	Typ používaný pro operace aktualizace služby.
Services	Rozhraní představující služby
ServicesCreateOrUpdateOptionalParams	Volitelné parametry.
ServicesDeleteOptionalParams	Volitelné parametry.
ServicesExportMetadataSchemaHeaders	Definuje hlavičky pro operaci Services_exportMetadataSchema.
ServicesExportMetadataSchemaOptionalParams	Volitelné parametry.
ServicesGetOptionalParams	Volitelné parametry.
ServicesListByResourceGroupNextOptionalParams	Volitelné parametry.
ServicesListByResourceGroupOptionalParams	Volitelné parametry.
ServicesListBySubscriptionNextOptionalParams	Volitelné parametry.
ServicesListBySubscriptionOptionalParams	Volitelné parametry.
ServicesUpdateOptionalParams	Volitelné parametry.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
TermsOfService	Podmínky služby pro rozhraní API
TrackedResource	Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem
Workspace	Entita pracovního prostoru
WorkspaceListResult	Odpověď operace seznamu pracovních prostorů.
WorkspaceProperties	Vlastnosti pracovního prostoru
Workspaces	Rozhraní představující pracovní prostory
WorkspacesCreateOrUpdateHeaders	Definuje hlavičky pro operaci Workspaces_createOrUpdate.
WorkspacesCreateOrUpdateOptionalParams	Volitelné parametry.
WorkspacesDeleteOptionalParams	Volitelné parametry.
WorkspacesGetHeaders	Definuje hlavičky pro operaci Workspaces_get.
WorkspacesGetOptionalParams	Volitelné parametry.
WorkspacesHeadOptionalParams	Volitelné parametry.
WorkspacesListNextOptionalParams	Volitelné parametry.
WorkspacesListOptionalParams	Volitelné parametry.

Aliasy typu

ActionType	Definuje hodnoty pro ActionType. PoleActionType lze použít zaměnitelně s ActionType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou interní
ApiDefinitionsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Obsahuje data odpovědi pro operaci exportSpecification.
ApiDefinitionsGetResponse	Obsahuje data odpovědí pro operaci get.
ApiDefinitionsHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
ApiDefinitionsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
ApiDefinitionsListResponse	Obsahuje data odpovědí pro operaci seznamu.
ApiKind	Definuje hodnoty pro ApiKind. PoleApiKind lze použít zaměnitelně s ApiKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou rest: Rozhraní API pro reprezentaci přenosu stavu graphql: Rozhraní API dotazovacího jazyka Graphu grpc: Rozhraní API gRPC soap: Rozhraní API SOAP webhooku: Web Hook protokolu websocket: Webový soket
ApiSpecExportResultFormat	Definuje hodnoty pro ApiSpecExportResultFormat. PoleApiSpecExportResultFormat lze použít zaměnitelně s ApiSpecExportResultFormat, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vložený: Vložený obsah dokumentu specifikace. propojení: Odkaz na výsledek operace exportu. Adresa URL je platná po dobu 5 minut.
ApiSpecImportSourceFormat	Definuje hodnoty pro ApiSpecImportSourceFormat. PoleApiSpecImportSourceFormat lze použít zaměnitelně s ApiSpecImportSourceFormat, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vložený: Vložený obsah dokumentu specifikace. odkaz: Odkaz na dokument specifikace hostovaný na veřejně přístupné internetové adrese.
ApiVersionsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
ApiVersionsGetResponse	Obsahuje data odpovědí pro operaci get.
ApiVersionsHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
ApiVersionsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
ApiVersionsListResponse	Obsahuje data odpovědí pro operaci seznamu.
ApisCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
ApisGetResponse	Obsahuje data odpovědí pro operaci get.
ApisHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
ApisListNextResponse	Obsahuje data odpovědi pro operaci listNext.
ApisListResponse	Obsahuje data odpovědí pro operaci seznamu.
CreatedByType	Definuje hodnoty pro CreatedByType. PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou uživatele aplikace ManagedIdentity klíč
DeploymentState	Definuje hodnoty pro DeploymentState. KnownDeploymentState lze použít zaměnitelně s DeploymentState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou aktivní: Aktivní stav neaktivní: Neaktivní stav
DeploymentsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
DeploymentsGetResponse	Obsahuje data odpovědí pro operaci get.
DeploymentsHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
DeploymentsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
DeploymentsListResponse	Obsahuje data odpovědí pro operaci seznamu.
EnvironmentKind	Definuje hodnoty pro EnvironmentKind. PoleEnvironmentKind lze použít zaměnitelně s EnvironmentKind, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vývojový: Vývojové prostředí testování: Testovací prostředí přípravných: Přípravné prostředí produkční: Produkční prostředí
EnvironmentServerType	Definuje hodnoty pro EnvironmentServerType. PoleEnvironmentServerType lze použít zaměnitelně s EnvironmentServerType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou azure API Management: Api Management Server výpočetní služby Azure: Výpočetní server apigee API Management: Server Apigee brány rozhraní API AWS: Server brány rozhraní API AWS Brány rozhraní Kong API: Server brány rozhraní API Kong Kubernetes: Server Kubernetes MuleSoft API Management: Server Mulesoft Api Management
EnvironmentsCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
EnvironmentsGetResponse	Obsahuje data odpovědí pro operaci get.
EnvironmentsHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
EnvironmentsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
EnvironmentsListResponse	Obsahuje data odpovědí pro operaci seznamu.
LifecycleStage	Definuje hodnoty pro LifecycleStage. KnownLifecycleStage lze použít zaměnitelně s LifecycleStage, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou návrhu: fáze návrhu vývoj: fáze vývoje testování: fáze testování preview: Ve verzi Preview produkční: V produkčním prostředí zastaralé: zastaralá fáze vyřazené: Vyřazená fáze
ManagedServiceIdentityType	Definuje hodnoty pro ManagedServiceIdentityType. PoleManagedServiceIdentityType lze použít zaměnitelně s ManagedServiceIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Žádné systemAssigned přiřazené uživatelem SystemAssigned, UserAssigned
MetadataAssignmentEntity	Definuje hodnoty pro MetadataAssignmentEntity. PoleMetadataAssignmentEntity lze použít zaměnitelně s MetadataAssignmentEntity, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou rozhraní API: Přiřazeno k rozhraní API prostředí: Přiřazeno k prostředí nasazení: Přiřazeno k nasazení
MetadataSchemaExportFormat	Definuje hodnoty pro MetadataSchemaExportFormat. PoleMetadataSchemaExportFormat lze použít zaměnitelně s MetadataSchemaExportFormat, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vložené: Vložený obsah dokumentu schématu. propojení: Odkaz na dokument schématu. Adresa URL je platná po dobu 5 minut.
MetadataSchemasCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
MetadataSchemasGetResponse	Obsahuje data odpovědí pro operaci get.
MetadataSchemasHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
MetadataSchemasListNextResponse	Obsahuje data odpovědi pro operaci listNext.
MetadataSchemasListResponse	Obsahuje data odpovědí pro operaci seznamu.
OperationsListNextResponse	Obsahuje data odpovědi pro operaci listNext.
OperationsListResponse	Obsahuje data odpovědí pro operaci seznamu.
Origin	Definuje hodnoty pro Origin. PoleOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou uživatele systémová uživatel, systémová
ProvisioningState	Definuje hodnoty pro ProvisioningState. KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou Úspěšné: Prostředek byl vytvořen. selhalo: Vytvoření prostředku se nezdařilo. Zrušeno: Vytvoření prostředku bylo zrušeno.
ServicesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
ServicesExportMetadataSchemaResponse	Obsahuje data odpovědi pro operaci exportMetadataSchema.
ServicesGetResponse	Obsahuje data odpovědí pro operaci get.
ServicesListByResourceGroupNextResponse	Obsahuje data odpovědi pro operaci listByResourceGroupNext.
ServicesListByResourceGroupResponse	Obsahuje data odpovědi pro operaci listByResourceGroup.
ServicesListBySubscriptionNextResponse	Obsahuje data odpovědi pro operaci listBySubscriptionNext.
ServicesListBySubscriptionResponse	Obsahuje data odpovědi pro operaci listBySubscription.
ServicesUpdateResponse	Obsahuje data odpovědí pro operaci aktualizace.
Versions	Definuje hodnoty pro verze. PoleVersions lze použít zaměnitelně s versions, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou 2024-03-01: Počáteční verze služby
WorkspacesCreateOrUpdateResponse	Obsahuje data odpovědí pro operaci createOrUpdate.
WorkspacesGetResponse	Obsahuje data odpovědí pro operaci get.
WorkspacesHeadResponse	Obsahuje data odpovědí pro hlavní operaci.
WorkspacesListNextResponse	Obsahuje data odpovědi pro operaci listNext.
WorkspacesListResponse	Obsahuje data odpovědí pro operaci seznamu.

Výčty

KnownActionType	Známé hodnoty ActionType, které služba přijímá.
KnownApiKind	Známé hodnoty ApiKind, které služba přijímá.
KnownApiSpecExportResultFormat	Známé hodnoty ApiSpecExportResultFormat, které služba přijímá.
KnownApiSpecImportSourceFormat	Známé hodnoty ApiSpecImportSourceFormat, které služba přijímá.
KnownCreatedByType	Známé hodnoty CreatedByType, které služba přijímá.
KnownDeploymentState	Známé hodnoty DeploymentState, které služba přijímá.
KnownEnvironmentKind	Známé hodnoty EnvironmentKind, které služba přijímá.
KnownEnvironmentServerType	Známé hodnoty EnvironmentServerType, které služba přijímá.
KnownLifecycleStage	Známé hodnoty LifecycleStage, které služba přijímá.
KnownManagedServiceIdentityType	Známé hodnoty ManagedServiceIdentityType, které služba přijímá.
KnownMetadataAssignmentEntity	Známé hodnoty MetadataAssignmentEntity, které služba přijímá.
KnownMetadataSchemaExportFormat	Známé hodnoty MetadataSchemaExportFormat, které služba přijímá.
KnownOrigin	Známé hodnoty Origin, které služba přijímá.
KnownProvisioningState	Známé hodnoty ProvisioningState, které služba přijímá.
KnownVersions	Známé hodnoty verzí , které služba přijímá.

Funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

Podrobnosti funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Objekt z přístupu k value na IteratorResult z byPage iterátoru.

Návraty

string | undefined

Token pokračování, který lze předat do byPage() během budoucích volání.