@azure/arm-apicenter package

Classi

AzureAPICenter

Interfacce

Api	Entità API.
ApiDefinition	Entità definizione API.
ApiDefinitionListResult	Risposta di un'operazione dell'elenco ApiDefinition.
ApiDefinitionProperties	Entità delle proprietà della definizione API.
ApiDefinitionPropertiesSpecification	Dettagli della specifica DELL'API.
ApiDefinitions	Interfaccia che rappresenta un oggetto ApiDefinitions.
ApiDefinitionsCreateOrUpdateHeaders	Definisce le intestazioni per ApiDefinitions_createOrUpdate'operazione.
ApiDefinitionsCreateOrUpdateOptionalParams	Parametri facoltativi.
ApiDefinitionsDeleteOptionalParams	Parametri facoltativi.
ApiDefinitionsExportSpecificationHeaders	Definisce le intestazioni per ApiDefinitions_exportSpecification'operazione.
ApiDefinitionsExportSpecificationOptionalParams	Parametri facoltativi.
ApiDefinitionsGetHeaders	Definisce le intestazioni per ApiDefinitions_get'operazione.
ApiDefinitionsGetOptionalParams	Parametri facoltativi.
ApiDefinitionsHeadOptionalParams	Parametri facoltativi.
ApiDefinitionsImportSpecificationHeaders	Definisce le intestazioni per ApiDefinitions_importSpecification'operazione.
ApiDefinitionsImportSpecificationOptionalParams	Parametri facoltativi.
ApiDefinitionsListNextOptionalParams	Parametri facoltativi.
ApiDefinitionsListOptionalParams	Parametri facoltativi.
ApiListResult	Risposta di un'operazione dell'elenco api.
ApiProperties	Proprietà API.
ApiSpecExportResult	Risultato dell'esportazione della specifica API.
ApiSpecImportRequest	Proprietà dell'entità di origine della specifica API.
ApiSpecImportRequestSpecification	Dettagli della specifica DELL'API.
ApiVersion	Entità versione API.
ApiVersionListResult	Risposta di un'operazione dell'elenco ApiVersion.
ApiVersionProperties	Entità delle proprietà della versione dell'API.
ApiVersions	Interfaccia che rappresenta un oggetto ApiVersions.
ApiVersionsCreateOrUpdateHeaders	Definisce le intestazioni per ApiVersions_createOrUpdate'operazione.
ApiVersionsCreateOrUpdateOptionalParams	Parametri facoltativi.
ApiVersionsDeleteOptionalParams	Parametri facoltativi.
ApiVersionsGetHeaders	Definisce le intestazioni per ApiVersions_get'operazione.
ApiVersionsGetOptionalParams	Parametri facoltativi.
ApiVersionsHeadOptionalParams	Parametri facoltativi.
ApiVersionsListNextOptionalParams	Parametri facoltativi.
ApiVersionsListOptionalParams	Parametri facoltativi.
Apis	Interfaccia che rappresenta un'API.
ApisCreateOrUpdateHeaders	Definisce le intestazioni per Apis_createOrUpdate'operazione.
ApisCreateOrUpdateOptionalParams	Parametri facoltativi.
ApisDeleteOptionalParams	Parametri facoltativi.
ApisGetHeaders	Definisce le intestazioni per Apis_get'operazione.
ApisGetOptionalParams	Parametri facoltativi.
ApisHeadOptionalParams	Parametri facoltativi.
ApisListNextOptionalParams	Parametri facoltativi.
ApisListOptionalParams	Parametri facoltativi.
AzureAPICenterOptionalParams	Parametri facoltativi.
Contact	Informazioni contatto
Deployment	Entità di distribuzione API.
DeploymentListResult	Risposta di un'operazione dell'elenco di distribuzione.
DeploymentProperties	Proprietà dell'entità di distribuzione API.
DeploymentServer	Server
Deployments	Interfaccia che rappresenta una distribuzione.
DeploymentsCreateOrUpdateHeaders	Definisce le intestazioni per Deployments_createOrUpdate'operazione.
DeploymentsCreateOrUpdateOptionalParams	Parametri facoltativi.
DeploymentsDeleteOptionalParams	Parametri facoltativi.
DeploymentsGetHeaders	Definisce le intestazioni per l'operazione di Deployments_get.
DeploymentsGetOptionalParams	Parametri facoltativi.
DeploymentsHeadOptionalParams	Parametri facoltativi.
DeploymentsListNextOptionalParams	Parametri facoltativi.
DeploymentsListOptionalParams	Parametri facoltativi.
Environment	Entità ambiente.
EnvironmentListResult	Risposta di un'operazione di elenco di ambiente.
EnvironmentProperties	Entità delle proprietà dell'ambiente.
EnvironmentServer	Informazioni sul server dell'ambiente.
Environments	Interfaccia che rappresenta un ambiente.
EnvironmentsCreateOrUpdateHeaders	Definisce le intestazioni per l'operazione di Environments_createOrUpdate.
EnvironmentsCreateOrUpdateOptionalParams	Parametri facoltativi.
EnvironmentsDeleteOptionalParams	Parametri facoltativi.
EnvironmentsGetHeaders	Definisce le intestazioni per l'operazione di Environments_get.
EnvironmentsGetOptionalParams	Parametri facoltativi.
EnvironmentsHeadOptionalParams	Parametri facoltativi.
EnvironmentsListNextOptionalParams	Parametri facoltativi.
EnvironmentsListOptionalParams	Parametri facoltativi.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta dell'errore OData.
ExternalDocumentation	Documentazione esterna aggiuntiva per l'API.
License	Informazioni sulla licenza per l'API.
ManagedServiceIdentity	Identità del servizio gestita (identità assegnata dal sistema e/o assegnata dall'utente)
MetadataAssignment	Metadati dell'assegnazione
MetadataSchema	Entità dello schema dei metadati. Usato per definire i metadati per le entità nel catalogo API.
MetadataSchemaExportRequest	Richiesta di esportazione dello schema dei metadati.
MetadataSchemaExportResult	Risultato dell'esportazione dello schema dei metadati.
MetadataSchemaListResult	Risposta di un'operazione di elenco MetadataSchema.
MetadataSchemaProperties	Proprietà dello schema dei metadati.
MetadataSchemas	Interfaccia che rappresenta un oggetto MetadataSchemas.
MetadataSchemasCreateOrUpdateHeaders	Definisce le intestazioni per l'operazione di MetadataSchemas_createOrUpdate.
MetadataSchemasCreateOrUpdateOptionalParams	Parametri facoltativi.
MetadataSchemasDeleteOptionalParams	Parametri facoltativi.
MetadataSchemasGetHeaders	Definisce le intestazioni per l'operazione di MetadataSchemas_get.
MetadataSchemasGetOptionalParams	Parametri facoltativi.
MetadataSchemasHeadOptionalParams	Parametri facoltativi.
MetadataSchemasListNextOptionalParams	Parametri facoltativi.
MetadataSchemasListOptionalParams	Parametri facoltativi.
Onboarding	Informazioni sull'onboarding
Operation	Dettagli di un'operazione DELL'API REST, restituita dall'API Operazioni provider di risorse
OperationDisplay	Informazioni di visualizzazione localizzate per questa operazione specifica.
OperationListResult	Elenco delle operazioni dell'API REST supportate da un provider di risorse di Azure. Contiene un collegamento URL per ottenere il set successivo di risultati.
Operations	Interfaccia che rappresenta un'operazione.
OperationsListNextOptionalParams	Parametri facoltativi.
OperationsListOptionalParams	Parametri facoltativi.
ProxyResource	Definizione del modello di risorsa per una risorsa proxy di Azure Resource Manager. Non avrà tag e una posizione
Resource	Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager
Service	Entità del servizio.
ServiceListResult	Risposta di un'operazione elenco di servizi.
ServiceProperties	Proprietà del servizio.
ServiceUpdate	Tipo utilizzato per le operazioni di aggiornamento del servizio.
Services	Interfaccia che rappresenta un servizio.
ServicesCreateOrUpdateOptionalParams	Parametri facoltativi.
ServicesDeleteOptionalParams	Parametri facoltativi.
ServicesExportMetadataSchemaHeaders	Definisce le intestazioni per l'operazione di Services_exportMetadataSchema.
ServicesExportMetadataSchemaOptionalParams	Parametri facoltativi.
ServicesGetOptionalParams	Parametri facoltativi.
ServicesListByResourceGroupNextOptionalParams	Parametri facoltativi.
ServicesListByResourceGroupOptionalParams	Parametri facoltativi.
ServicesListBySubscriptionNextOptionalParams	Parametri facoltativi.
ServicesListBySubscriptionOptionalParams	Parametri facoltativi.
ServicesUpdateOptionalParams	Parametri facoltativi.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TermsOfService	Condizioni di servizio per l'API.
TrackedResource	Definizione del modello di risorsa per una risorsa di primo livello di Azure Resource Manager tracciata con 'tag' e 'location'
UserAssignedIdentity	Proprietà di identità assegnate dall'utente
Workspace	Entità dell'area di lavoro.
WorkspaceListResult	Risposta di un'operazione elenco di aree di lavoro.
WorkspaceProperties	Proprietà dell'area di lavoro.
Workspaces	Interfaccia che rappresenta un'area di lavoro.
WorkspacesCreateOrUpdateHeaders	Definisce le intestazioni per l'operazione di Workspaces_createOrUpdate.
WorkspacesCreateOrUpdateOptionalParams	Parametri facoltativi.
WorkspacesDeleteOptionalParams	Parametri facoltativi.
WorkspacesGetHeaders	Definisce le intestazioni per l'operazione di Workspaces_get.
WorkspacesGetOptionalParams	Parametri facoltativi.
WorkspacesHeadOptionalParams	Parametri facoltativi.
WorkspacesListNextOptionalParams	Parametri facoltativi.
WorkspacesListOptionalParams	Parametri facoltativi.

Alias tipo

ActionType	Definisce i valori per ActionType. KnownActionType può essere usato in modo intercambiabile con ActionType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Interno
ApiDefinitionsCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Contiene i dati di risposta per l'operazione exportSpecification.
ApiDefinitionsGetResponse	Contiene i dati di risposta per l'operazione get.
ApiDefinitionsHeadResponse	Contiene i dati di risposta per l'operazione head.
ApiDefinitionsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
ApiDefinitionsListResponse	Contiene i dati di risposta per l'operazione di elenco.
ApiKind	Definisce i valori per ApiKind. KnownApiKind può essere usato in modo intercambiabile con ApiKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio rest: API di trasferimento dello stato rappresentativo graphql: API del linguaggio di query Graph grpc: Api gRPC soap: API SOAP webhook: Web Hook websocket: Web Socket
ApiSpecExportResultFormat	Definisce i valori per ApiSpecExportResultFormat. KnownApiSpecExportResultFormat può essere usato in modo intercambiabile con ApiSpecExportResultFormat. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio inline: contenuto inlined di un documento di specifica. link: collegamento al risultato dell'operazione di esportazione. L'URL è valido per 5 minuti.
ApiSpecImportSourceFormat	Definisce i valori per ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat può essere usato in modo intercambiabile con ApiSpecImportSourceFormat. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio inline: contenuto inlined di un documento di specifica. link: collegamento a un documento di specifica ospitato in un indirizzo Internet accessibile pubblicamente.
ApiVersionsCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
ApiVersionsGetResponse	Contiene i dati di risposta per l'operazione get.
ApiVersionsHeadResponse	Contiene i dati di risposta per l'operazione head.
ApiVersionsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
ApiVersionsListResponse	Contiene i dati di risposta per l'operazione di elenco.
ApisCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
ApisGetResponse	Contiene i dati di risposta per l'operazione get.
ApisHeadResponse	Contiene i dati di risposta per l'operazione head.
ApisListNextResponse	Contiene i dati di risposta per l'operazione listNext.
ApisListResponse	Contiene i dati di risposta per l'operazione di elenco.
CreatedByType	Definisce i valori per CreatedByType. KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType. Questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Utente Applicazione ManagedIdentity Chiave
DeploymentState	Definisce i valori per DeploymentState. NotoDeploymentState può essere usato in modo intercambiabile con DeploymentState, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio attivo: stato attivo inattivo: stato inattivo
DeploymentsCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
DeploymentsGetResponse	Contiene i dati di risposta per l'operazione get.
DeploymentsHeadResponse	Contiene i dati di risposta per l'operazione head.
DeploymentsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
DeploymentsListResponse	Contiene i dati di risposta per l'operazione di elenco.
EnvironmentKind	Definisce i valori per EnvironmentKind. NotoEnvironmentKind può essere usato in modo interscambiabile con EnvironmentKind, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio sviluppo: ambiente di sviluppo test: Ambiente di test staging: ambiente di gestione temporanea produzione: ambiente di produzione
EnvironmentServerType	Definisce i valori per EnvironmentServerType. NotoEnvironmentServerType può essere usato in modo interscambiabile con EnvironmentServerType, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Azure Gestione API: Server gestione API Servizio di calcolo di Azure: server di calcolo Apigee Gestione API: Server Apigee Gateway API AWS: server del gateway API AWS Gateway API Kong: server gateway API Kong Kubernetes: server Kubernetes MuleSoft Gestione API: server di gestione api Mulesoft
EnvironmentsCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
EnvironmentsGetResponse	Contiene i dati di risposta per l'operazione get.
EnvironmentsHeadResponse	Contiene i dati di risposta per l'operazione head.
EnvironmentsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
EnvironmentsListResponse	Contiene i dati di risposta per l'operazione di elenco.
LifecycleStage	Definisce i valori per LifecycleStage. NotoLifecycleStage può essere usato in modo interscambiabile con LifecycleStage, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio progettazione: fase di progettazione sviluppo: fase di sviluppo test: fase di test anteprima: in anteprima produzione: in produzione deprecato: fase deprecata ritirata: fase ritirata
ManagedServiceIdentityType	Definisce i valori per ManagedServiceIdentityType. NotoManagedServiceIdentityType può essere usato in modo interscambiabile con ManagedServiceIdentityType, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Nessuna SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Definisce i valori per MetadataAssignmentEntity. NotaMetadataAssignmentEntity può essere usata in modo interscambiabile con MetadataAssignmentEntity, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio api: assegnata all'API ambiente: assegnato all'ambiente distribuzione: assegnata alla distribuzione
MetadataSchemaExportFormat	Definisce i valori per MetadataSchemaExportFormat. NotoMetadataSchemaExportFormat può essere usato in modo interscambiabile con MetadataSchemaExportFormat, questo enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio inline: contenuto inlined di un documento dello schema. link: collegamento a un documento dello schema. L'URL è valido per 5 minuti.
MetadataSchemasCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
MetadataSchemasGetResponse	Contiene i dati di risposta per l'operazione get.
MetadataSchemasHeadResponse	Contiene i dati di risposta per l'operazione head.
MetadataSchemasListNextResponse	Contiene i dati di risposta per l'operazione listNext.
MetadataSchemasListResponse	Contiene i dati di risposta per l'operazione di elenco.
OperationsListNextResponse	Contiene i dati di risposta per l'operazione listNext.
OperationsListResponse	Contiene i dati di risposta per l'operazione di elenco.
Origin	Definisce i valori per Origin. NotoOrigin può essere usato in modo intercambiabile con Origin, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio user sistema user,system
ProvisioningState	Definisce i valori per ProvisioningState. NotoProvisioningState può essere usato in modo interscambiabile con ProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio Riuscito: la risorsa è stata creata. Impossibile: creazione di risorse non riuscita. Annullata: la creazione della risorsa è stata annullata.
ServicesCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
ServicesExportMetadataSchemaResponse	Contiene i dati di risposta per l'operazione exportMetadataSchema.
ServicesGetResponse	Contiene i dati di risposta per l'operazione get.
ServicesListByResourceGroupNextResponse	Contiene i dati di risposta per l'operazione listByResourceGroupNext.
ServicesListByResourceGroupResponse	Contiene i dati di risposta per l'operazione listByResourceGroup.
ServicesListBySubscriptionNextResponse	Contiene i dati di risposta per l'operazione listBySubscriptionNext.
ServicesListBySubscriptionResponse	Contiene i dati di risposta per l'operazione listBySubscription.
ServicesUpdateResponse	Contiene i dati di risposta per l'operazione di aggiornamento.
Versions	Definisce i valori per Versioni. NoteVersions può essere usato in modo interscambiabile con Versioni, questa enumerazione contiene i valori noti supportati dal servizio. Valori noti supportati dal servizio 2024-03-01: versione iniziale del servizio
WorkspacesCreateOrUpdateResponse	Contiene i dati di risposta per l'operazione createOrUpdate.
WorkspacesGetResponse	Contiene i dati di risposta per l'operazione get.
WorkspacesHeadResponse	Contiene i dati di risposta per l'operazione head.
WorkspacesListNextResponse	Contiene i dati di risposta per l'operazione listNext.
WorkspacesListResponse	Contiene i dati di risposta per l'operazione di elenco.

Enumerazioni

KnownActionType	Valori noti di ActionType accettati dal servizio.
KnownApiKind	Valori noti di ApiKind accettati dal servizio.
KnownApiSpecExportResultFormat	Valori noti di ApiSpecExportResultFormat accettati dal servizio.
KnownApiSpecImportSourceFormat	Valori noti di ApiSpecImportSourceFormat accettati dal servizio.
KnownCreatedByType	Valori noti di CreateByType accettati dal servizio.
KnownDeploymentState	Valori noti di DeploymentState accettati dal servizio.
KnownEnvironmentKind	Valori noti di EnvironmentKind accettati dal servizio.
KnownEnvironmentServerType	Valori noti di EnvironmentServerType accettati dal servizio.
KnownLifecycleStage	Valori noti di LifecycleStage accettati dal servizio.
KnownManagedServiceIdentityType	Valori noti di ManagedServiceIdentityType accettati dal servizio.
KnownMetadataAssignmentEntity	Valori noti di MetadataAssignmentEntity accetta il servizio.
KnownMetadataSchemaExportFormat	Valori noti di MetadataSchemaExportFormat accettati dal servizio.
KnownOrigin	Valori noti di Origin accettati dal servizio.
KnownProvisioningState	Valori noti di ProvisioningState accettati dal servizio.
KnownVersions	Valori noti di Versioni accettate dal servizio.

Funzioni

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage , restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

Dettagli funzione

getContinuationToken(unknown)

Dato l'ultimo .value prodotto dall'iteratore byPage , restituisce un token di continuazione che può essere usato per iniziare il paging da quel punto in un secondo momento.

function getContinuationToken(page: unknown): string | undefined

Parametri

page

unknown

Oggetto dall'accesso value all'iteratorResult da un byPage iteratore.

Restituisce

string | undefined

Token di continuazione che può essere passato a byPage() durante le chiamate future.