@azure/arm-apicenter package

Clases

AzureAPICenter

Interfaces

Api	Entidad de API.
ApiDefinition	Entidad de definición de API.
ApiDefinitionListResult	Respuesta de una operación de lista apiDefinition.
ApiDefinitionProperties	Entidad de propiedades de definición de API.
ApiDefinitionPropertiesSpecification	Detalles de la especificación de API.
ApiDefinitions	Interfaz que representa una ApiDefinitions.
ApiDefinitionsCreateOrUpdateHeaders	Define encabezados para ApiDefinitions_createOrUpdate operación.
ApiDefinitionsCreateOrUpdateOptionalParams	Parámetros opcionales.
ApiDefinitionsDeleteOptionalParams	Parámetros opcionales.
ApiDefinitionsExportSpecificationHeaders	Define encabezados para ApiDefinitions_exportSpecification operación.
ApiDefinitionsExportSpecificationOptionalParams	Parámetros opcionales.
ApiDefinitionsGetHeaders	Define encabezados para ApiDefinitions_get operación.
ApiDefinitionsGetOptionalParams	Parámetros opcionales.
ApiDefinitionsHeadOptionalParams	Parámetros opcionales.
ApiDefinitionsImportSpecificationHeaders	Define encabezados para ApiDefinitions_importSpecification operación.
ApiDefinitionsImportSpecificationOptionalParams	Parámetros opcionales.
ApiDefinitionsListNextOptionalParams	Parámetros opcionales.
ApiDefinitionsListOptionalParams	Parámetros opcionales.
ApiListResult	Respuesta de una operación de lista de API.
ApiProperties	Propiedades de API.
ApiSpecExportResult	Resultado de exportación de la especificación de API.
ApiSpecImportRequest	Propiedades de entidad de origen de especificación de API.
ApiSpecImportRequestSpecification	Detalles de la especificación de API.
ApiVersion	Entidad de versión de API.
ApiVersionListResult	Respuesta de una operación de lista ApiVersion.
ApiVersionProperties	Entidad de propiedades de la versión de API.
ApiVersions	Interfaz que representa una apiVersions.
ApiVersionsCreateOrUpdateHeaders	Define encabezados para ApiVersions_createOrUpdate operación.
ApiVersionsCreateOrUpdateOptionalParams	Parámetros opcionales.
ApiVersionsDeleteOptionalParams	Parámetros opcionales.
ApiVersionsGetHeaders	Define encabezados para ApiVersions_get operación.
ApiVersionsGetOptionalParams	Parámetros opcionales.
ApiVersionsHeadOptionalParams	Parámetros opcionales.
ApiVersionsListNextOptionalParams	Parámetros opcionales.
ApiVersionsListOptionalParams	Parámetros opcionales.
Apis	Interfaz que representa una API.
ApisCreateOrUpdateHeaders	Define encabezados para Apis_createOrUpdate operación.
ApisCreateOrUpdateOptionalParams	Parámetros opcionales.
ApisDeleteOptionalParams	Parámetros opcionales.
ApisGetHeaders	Define encabezados para Apis_get operación.
ApisGetOptionalParams	Parámetros opcionales.
ApisHeadOptionalParams	Parámetros opcionales.
ApisListNextOptionalParams	Parámetros opcionales.
ApisListOptionalParams	Parámetros opcionales.
AzureAPICenterOptionalParams	Parámetros opcionales.
Contact	Información de contacto
Deployment	Entidad de implementación de API.
DeploymentListResult	Respuesta de una operación de lista de implementación.
DeploymentProperties	Propiedades de entidad de implementación de API.
DeploymentServer	Servidor
Deployments	Interfaz que representa una implementación.
DeploymentsCreateOrUpdateHeaders	Define encabezados para Deployments_createOrUpdate operación.
DeploymentsCreateOrUpdateOptionalParams	Parámetros opcionales.
DeploymentsDeleteOptionalParams	Parámetros opcionales.
DeploymentsGetHeaders	Define encabezados para Deployments_get operación.
DeploymentsGetOptionalParams	Parámetros opcionales.
DeploymentsHeadOptionalParams	Parámetros opcionales.
DeploymentsListNextOptionalParams	Parámetros opcionales.
DeploymentsListOptionalParams	Parámetros opcionales.
Environment	Entidad de entorno.
EnvironmentListResult	Respuesta de una operación de lista de entornos.
EnvironmentProperties	Entidad de propiedades del entorno.
EnvironmentServer	Información del servidor del entorno.
Environments	Interfaz que representa un entorno.
EnvironmentsCreateOrUpdateHeaders	Define encabezados para Environments_createOrUpdate operación.
EnvironmentsCreateOrUpdateOptionalParams	Parámetros opcionales.
EnvironmentsDeleteOptionalParams	Parámetros opcionales.
EnvironmentsGetHeaders	Define encabezados para Environments_get operación.
EnvironmentsGetOptionalParams	Parámetros opcionales.
EnvironmentsHeadOptionalParams	Parámetros opcionales.
EnvironmentsListNextOptionalParams	Parámetros opcionales.
EnvironmentsListOptionalParams	Parámetros opcionales.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
ExternalDocumentation	Documentación adicional externa para la API.
License	La información de licencia de la API.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
MetadataAssignment	Metadatos de asignación
MetadataSchema	Entidad de esquema de metadatos. Se usa para definir metadatos para las entidades del catálogo de API.
MetadataSchemaExportRequest	Solicitud de exportación del esquema de metadatos.
MetadataSchemaExportResult	Resultado de exportación del esquema de metadatos.
MetadataSchemaListResult	Respuesta de una operación de lista MetadataSchema.
MetadataSchemaProperties	Propiedades del esquema de metadatos.
MetadataSchemas	Interfaz que representa un metadataSchemas.
MetadataSchemasCreateOrUpdateHeaders	Define encabezados para MetadataSchemas_createOrUpdate operación.
MetadataSchemasCreateOrUpdateOptionalParams	Parámetros opcionales.
MetadataSchemasDeleteOptionalParams	Parámetros opcionales.
MetadataSchemasGetHeaders	Define encabezados para MetadataSchemas_get operación.
MetadataSchemasGetOptionalParams	Parámetros opcionales.
MetadataSchemasHeadOptionalParams	Parámetros opcionales.
MetadataSchemasListNextOptionalParams	Parámetros opcionales.
MetadataSchemasListOptionalParams	Parámetros opcionales.
Onboarding	Información de incorporación
Operation	Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos
OperationDisplay	Información de visualización localizada para esta operación determinada.
OperationListResult	Una lista de las operaciones de API rest admitidas por un proveedor de recursos de Azure. Contiene un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
Operations	Interfaz que representa una operación.
OperationsListNextOptionalParams	Parámetros opcionales.
OperationsListOptionalParams	Parámetros opcionales.
ProxyResource	Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación
Resource	Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager
Service	Entidad de servicio.
ServiceListResult	Respuesta de una operación de lista de servicios.
ServiceProperties	Propiedades del servicio.
ServiceUpdate	Tipo utilizado para las operaciones de actualización del servicio.
Services	Interfaz que representa un servicio.
ServicesCreateOrUpdateOptionalParams	Parámetros opcionales.
ServicesDeleteOptionalParams	Parámetros opcionales.
ServicesExportMetadataSchemaHeaders	Define encabezados para Services_exportMetadataSchema operación.
ServicesExportMetadataSchemaOptionalParams	Parámetros opcionales.
ServicesGetOptionalParams	Parámetros opcionales.
ServicesListByResourceGroupNextOptionalParams	Parámetros opcionales.
ServicesListByResourceGroupOptionalParams	Parámetros opcionales.
ServicesListBySubscriptionNextOptionalParams	Parámetros opcionales.
ServicesListBySubscriptionOptionalParams	Parámetros opcionales.
ServicesUpdateOptionalParams	Parámetros opcionales.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
TermsOfService	Términos de servicio para la API.
TrackedResource	La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación".
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
Workspace	Entidad del área de trabajo.
WorkspaceListResult	Respuesta de una operación de lista del área de trabajo.
WorkspaceProperties	Propiedades del área de trabajo.
Workspaces	Interfaz que representa las áreas de trabajo.
WorkspacesCreateOrUpdateHeaders	Define encabezados para Workspaces_createOrUpdate operación.
WorkspacesCreateOrUpdateOptionalParams	Parámetros opcionales.
WorkspacesDeleteOptionalParams	Parámetros opcionales.
WorkspacesGetHeaders	Define encabezados para Workspaces_get operación.
WorkspacesGetOptionalParams	Parámetros opcionales.
WorkspacesHeadOptionalParams	Parámetros opcionales.
WorkspacesListNextOptionalParams	Parámetros opcionales.
WorkspacesListOptionalParams	Parámetros opcionales.

Alias de tipos

ActionType	Define valores para ActionType. KnownActionType se puede usar indistintamente con ActionType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio interno
ApiDefinitionsCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Contiene datos de respuesta para la operación exportSpecification.
ApiDefinitionsGetResponse	Contiene datos de respuesta para la operación get.
ApiDefinitionsHeadResponse	Contiene datos de respuesta para la operación principal.
ApiDefinitionsListNextResponse	Contiene datos de respuesta para la operación listNext.
ApiDefinitionsListResponse	Contiene datos de respuesta para la operación de lista.
ApiKind	Define valores para ApiKind. knownApiKind se puede usar indistintamente con ApiKind, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio rest: UNA API de transferencia de estado representacional graphql: A Graph Query Language Api grpc: Una api de gRPC soap: API SOAP webhook: Gancho web websocket: Web Socket
ApiSpecExportResultFormat	Define valores para ApiSpecExportResultFormat. knownApiSpecExportResultFormat se puede usar indistintamente con ApiSpecExportResultFormat, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio insertados: el contenido insertado de un documento de especificación. vínculo: vínculo al resultado de la operación de exportación. La dirección URL es válida durante 5 minutos.
ApiSpecImportSourceFormat	Define valores para ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat se puede usar indistintamente con ApiSpecImportSourceFormat, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio insertados: el contenido insertado de un documento de especificación. vínculo: vínculo a un documento de especificación hospedado en una dirección de Internet accesible públicamente.
ApiVersionsCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
ApiVersionsGetResponse	Contiene datos de respuesta para la operación get.
ApiVersionsHeadResponse	Contiene datos de respuesta para la operación principal.
ApiVersionsListNextResponse	Contiene datos de respuesta para la operación listNext.
ApiVersionsListResponse	Contiene datos de respuesta para la operación de lista.
ApisCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
ApisGetResponse	Contiene datos de respuesta para la operación get.
ApisHeadResponse	Contiene datos de respuesta para la operación principal.
ApisListNextResponse	Contiene datos de respuesta para la operación listNext.
ApisListResponse	Contiene datos de respuesta para la operación de lista.
CreatedByType	Define valores para CreatedByType. KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de usuario de Application managedIdentity clave
DeploymentState	Define valores para DeploymentState. KnownDeploymentState se puede usar indistintamente con DeploymentState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio activo: Estado activo inactivo: estado inactivo
DeploymentsCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
DeploymentsGetResponse	Contiene datos de respuesta para la operación get.
DeploymentsHeadResponse	Contiene datos de respuesta para la operación principal.
DeploymentsListNextResponse	Contiene datos de respuesta para la operación listNext.
DeploymentsListResponse	Contiene datos de respuesta para la operación de lista.
EnvironmentKind	Define valores para EnvironmentKind. KnownEnvironmentKind se puede usar indistintamente con EnvironmentKind, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de desarrollo: entorno de desarrollo pruebas: entorno de prueba de ensayo: entorno de ensayo de producción: entorno de producción
EnvironmentServerType	Define valores para EnvironmentServerType. KnownEnvironmentServerType se puede usar indistintamente con EnvironmentServerType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Azure API Management: Api Management Server servicio de proceso de Azure: servidor de proceso Apigee API Management: servidor apigee aws API Gateway: servidor de AWS Api Gateway Kong API Gateway: Servidor de puerta de enlace de API de Kong kubernetes: servidor de Kubernetes MuleSoft API Management: servidor de Mulesoft Api Management
EnvironmentsCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
EnvironmentsGetResponse	Contiene datos de respuesta para la operación get.
EnvironmentsHeadResponse	Contiene datos de respuesta para la operación principal.
EnvironmentsListNextResponse	Contiene datos de respuesta para la operación listNext.
EnvironmentsListResponse	Contiene datos de respuesta para la operación de lista.
LifecycleStage	Define valores para LifecycleStage. KnownLifecycleStage se puede usar indistintamente con LifecycleStage, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio diseño: fase de diseño de desarrollo: fase de desarrollo pruebas: fase de pruebas versión preliminar: en versión preliminar de producción: en producción en desuso: fase en desuso retirado: fase retirada
ManagedServiceIdentityType	Define valores para ManagedServiceIdentityType. KnownManagedServiceIdentityType se puede usar indistintamente con ManagedServiceIdentityType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Ninguno SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Define valores para MetadataAssignmentEntity. KnownMetadataAssignmentEntity se puede usar indistintamente con MetadataAssignmentEntity, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio api: asignado a la API entorno: asignado al entorno de implementación: asignado a la implementación
MetadataSchemaExportFormat	Define valores para MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat se puede usar indistintamente con MetadataSchemaExportFormat, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio insertados: el contenido insertado de un documento de esquema. vínculo: vínculo a un documento de esquema. La dirección URL es válida durante 5 minutos.
MetadataSchemasCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
MetadataSchemasGetResponse	Contiene datos de respuesta para la operación get.
MetadataSchemasHeadResponse	Contiene datos de respuesta para la operación principal.
MetadataSchemasListNextResponse	Contiene datos de respuesta para la operación listNext.
MetadataSchemasListResponse	Contiene datos de respuesta para la operación de lista.
OperationsListNextResponse	Contiene datos de respuesta para la operación listNext.
OperationsListResponse	Contiene datos de respuesta para la operación de lista.
Origin	Define valores para Origin. KnownOrigin se puede usar indistintamente con Origin, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio de usuario de del sistema usuario, del sistema
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState se puede usar indistintamente con ProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Correcto: se ha creado el recurso. Error: Error en la creación de recursos. cancelada: se canceló la creación de recursos.
ServicesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
ServicesExportMetadataSchemaResponse	Contiene datos de respuesta para la operación exportMetadataSchema.
ServicesGetResponse	Contiene datos de respuesta para la operación get.
ServicesListByResourceGroupNextResponse	Contiene datos de respuesta para la operación listByResourceGroupNext.
ServicesListByResourceGroupResponse	Contiene datos de respuesta para la operación listByResourceGroup.
ServicesListBySubscriptionNextResponse	Contiene datos de respuesta para la operación listBySubscriptionNext.
ServicesListBySubscriptionResponse	Contiene datos de respuesta para la operación listBySubscription.
ServicesUpdateResponse	Contiene datos de respuesta para la operación de actualización.
Versions	Define valores para Versiones. KnownVersions se puede usar indistintamente con Versiones, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio 2024-03-01: la versión inicial del servicio
WorkspacesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
WorkspacesGetResponse	Contiene datos de respuesta para la operación get.
WorkspacesHeadResponse	Contiene datos de respuesta para la operación principal.
WorkspacesListNextResponse	Contiene datos de respuesta para la operación listNext.
WorkspacesListResponse	Contiene datos de respuesta para la operación de lista.

Enumeraciones

KnownActionType	Los valores conocidos de ActionType que acepta el servicio.
KnownApiKind	Valores conocidos de ApiKind que acepta el servicio.
KnownApiSpecExportResultFormat	Valores conocidos de ApiSpecExportResultFormat que acepta el servicio.
KnownApiSpecImportSourceFormat	Valores conocidos de ApiSpecImportSourceFormat que acepta el servicio.
KnownCreatedByType	Los valores conocidos de CreatedByType que acepta el servicio.
KnownDeploymentState	Valores conocidos de DeploymentState que acepta el servicio.
KnownEnvironmentKind	Valores conocidos de EnvironmentKind que acepta el servicio.
KnownEnvironmentServerType	Los valores conocidos de EnvironmentServerType que acepta el servicio.
KnownLifecycleStage	Valores conocidos de LifecycleStage que acepta el servicio.
KnownManagedServiceIdentityType	Valores conocidos de ManagedServiceIdentityType que acepta el servicio.
KnownMetadataAssignmentEntity	Los valores conocidos de MetadataAssignmentEntity que acepta el servicio.
KnownMetadataSchemaExportFormat	Los valores conocidos de MetadataSchemaExportFormat que acepta el servicio.
KnownOrigin	Valores conocidos de Origin que acepta el servicio.
KnownProvisioningState	Valores conocidos de provisioningState que acepta el servicio.
KnownVersions	Los valores conocidos de Versiones que acepta el servicio.

Funciones

getContinuationToken(unknown)

Dada la última .value generada por el iterador de byPage, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

Detalles de la función

getContinuationToken(unknown)

Dada la última .value generada por el iterador de byPage, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

function getContinuationToken(page: unknown): string | undefined

Parámetros

page

unknown

Objeto desde el que se accede a value en IteratorResult desde un iterador de byPage.

Devoluciones

string | undefined

Token de continuación que se puede pasar a byPage() durante futuras llamadas.