Compartir a través de

Biblioteca cliente del proveedor de recursos de Azure Visual Studio para JavaScript: versión 4.0.0-beta.2

  • Artículo

Este paquete contiene un SDK isomórfico (se ejecuta tanto en Node.js como en exploradores) para el cliente del proveedor de recursos de Azure Visual Studio.

Use estas API para administrar Visual Studio Team Services recursos a través de Azure Resource Manager. Todas las operaciones de tareas se ajustan a la especificación del protocolo HTTP/1.1 y la todas las operaciones devuelven un encabezado x-ms-request-id que puede usarse para obtener información sobre la solicitud. Debe asegurarse de que las solicitudes realizadas a estos recursos sean seguras. Para obtener más información, vea /rest/api/index.

Código | fuente Paquete (NPM) | Documentación | de referencia de APIMuestras

Introducción

Entornos admitidos actualmente

Para más información, consulte la directiva de compatibilidad.

Requisitos previos

Instalar el paquete @azure/arm-visualstudio

Instale la biblioteca cliente del proveedor de recursos de Azure Visual Studio para JavaScript con npm:

npm install @azure/arm-visualstudio

Crear y autenticar una VisualStudioResourceProviderClient

Para crear un objeto de cliente para acceder a la API del proveedor de recursos de Azure Visual Studio, necesitará el endpoint del recurso del proveedor de recursos de Azure Visual Studio y un credential. El cliente del proveedor de recursos de Azure Visual Studio puede usar credenciales de Azure Active Directory para autenticarse. Puede encontrar el punto de conexión del recurso del proveedor de recursos de Azure Visual Studio en Azure Portal.

Puede autenticarse con Azure Active Directory mediante una credencial de la biblioteca de @azure/identidad o un token de AAD existente.

Para usar el proveedor DefaultAzureCredential que se muestra a continuación u otros proveedores de credenciales proporcionados con el SDK de Azure, instale el @azure/identity paquete:

npm install @azure/identity

También tendrá que registrar una nueva aplicación de AAD y conceder acceso al proveedor de recursos de Azure Visual Studio mediante la asignación del rol adecuado a la entidad de servicio (nota: los roles como "Owner" no concederán los permisos necesarios). Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de AAD como variables de entorno: AZURE_CLIENT_ID, , AZURE_TENANT_IDAZURE_CLIENT_SECRET.

Para más información sobre cómo crear una aplicación de Azure AD, consulte esta guía.

const { VisualStudioResourceProviderClient } = require("@azure/arm-visualstudio");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new VisualStudioResourceProviderClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new VisualStudioResourceProviderClient(credential, subscriptionId);

Paquete de JavaScript

Para usar esta biblioteca cliente en el explorador, primero debe usar un agrupador. Para más información sobre cómo hacerlo, consulte nuestra documentación de agrupación.

Conceptos clave

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient es la interfaz principal para los desarrolladores que usan la biblioteca cliente del proveedor de recursos de Azure Visual Studio. Explore los métodos de este objeto de cliente para comprender las diferentes características del servicio proveedor de recursos de Azure Visual Studio al que puede acceder.

Solución de problemas

Registro

La habilitación del registro puede ayudar a descubrir información útil sobre los errores. Para ver un registro de solicitudes y respuestas HTTP, establezca la variable de entorno AZURE_LOG_LEVEL en info. Como alternativa, el registro se puede habilitar en tiempo de ejecución llamando a setLogLevel en @azure/logger:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, consulte los documentos del paquete @azure/logger.

Pasos siguientes

Eche un vistazo al directorio de ejemplos para obtener ejemplos detallados sobre cómo usar esta biblioteca.

Contribuciones

Si desea contribuir a esta biblioteca, lea la guía de contribución para obtener más información sobre cómo compilar y probar el código.

Impresiones