Share via

Titik akhir layanan Azure DevOps CLI

  • Artikel

Azure DevOps

az devops service-endpoint Dengan perintah , Anda dapat membuat dan mengelola berbagai jenis koneksi layanan. Koneksi layanan memungkinkan Azure DevOps untuk berkomunikasi dengan layanan eksternal, seperti Azure, Bitbucket, Kubernetes, Maven, GitHub, dan banyak lagi. Dengan az devops service-endpoint, Anda dapat melakukan tugas berikut:

  • Membuat titik akhir layanan menggunakan file konfigurasi
  • Memperbarui titik akhir layanan
  • Mengelola titik akhir/koneksi layanan GitHub
  • Mengelola titik akhir/koneksi layanan Azure Resource Manager
  • Mencantumkan titik akhir layanan yang ditentukan untuk proyek
  • Dapatkan detail titik akhir layanan.

Untuk sintaks perintah detail, lihat az devops service-endpoint. Untuk sintaks pada REST API untuk titik akhir layanan, lihat Titik akhir.

Anda juga dapat menggunakan perintah azure cli untuk mendapatkan detail, mencantumkan, menghapus, dan memperbarui titik akhir layanan. Lihat Indeks ke contoh CLI Azure DevOps, Titik akhir layanan, atau koneksi layanan.

Untuk menggunakan portal web untuk membuat dan mengedit koneksi layanan, lihat Mengelola koneksi layanan.

Membuat titik akhir layanan menggunakan file konfigurasi

Untuk membuat titik akhir layanan menggunakan file konfigurasi, Anda harus terlebih dahulu menentukan file konfigurasi. Konten file konfigurasi berbeda tergantung pada jenis koneksi, seperti Azure Classic, Azure Data Explorer, Bitbucket Cloud, Chef, dan banyak lagi.

Format file konfigurasi

Sintaks berikut menunjukkan json format untuk file konfigurasi.

{
  "data": {},
  "name": "MyNewServiceEndpoint",
  "type": "Generic",
  "url": "https://myserver",
  "authorization": {
    "parameters": {
      "username": "myusername",
      "password": "mysecretpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Tabel berikut ini menjelaskan setiap parameter. Parameter type mendukung pembuatan semua jenis titik akhir layanan.

Parameter Jenis Deskripsi
name string Mengatur nama titik akhir yang mudah diingat.
type string Mengatur jenis titik akhir.
url string Mengatur url titik akhir.
authorization EndpointAuthorization Mengatur data otorisasi untuk berbicara dengan titik akhir.
isShared Boolean Menunjukkan apakah titik akhir layanan dibagikan dengan proyek lain atau tidak.
isReady Boolean Indikator status Titik Akhir.
serviceEndpointProjectReferences Referensi Proyek Mengatur referensi proyek titik akhir layanan.

Untuk daftar jenis yang didukung dan parameter input yang diperlukan, Anda dapat menjalankan entri REST API berikut:

https://dev.azure.com/{organization}/_apis/serviceendpoint/types?api-version=6.0-preview.1

Selain itu, untuk deskripsi jenis koneksi layanan dan parameter lain yang mungkin diperlukan, lihat Mengelola koneksi layanan, Jenis koneksi layanan umum.

Jalankan perintah create

Anda membuat titik akhir layanan dengan az devops service-endpoint create perintah .

az devops service-endpoint create --service-endpoint-configuration 
                                  [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                                  [--org]
                                  [--project]

Parameter

  • service-endpoint-configuration: Diperlukan. json Nama file konfigurasi dengan konfigurasi titik akhir layanan.
  • pengodean: Opsional. Pengodean file input. Defaultnya adalah utf-8. Nilai yang diterima: ascii, , utf-16leutf-16be, utf-8.
  • org: URL organisasi Azure DevOps. Anda dapat mengonfigurasi organisasi default menggunakan az devops configure -d organization=ORG_URL. Diperlukan jika tidak dikonfigurasi sebagai default.
  • project: Nama atau ID proyek. Anda dapat mengonfigurasi proyek default menggunakan az devops configure -d project=NAME_OR_ID. Diperlukan jika tidak dikonfigurasi sebagai default.

Contoh

Perintah berikut membuat koneksi layanan yang mereferensikan ServiceConnectionGeneric.json file.

az devops service-endpoint create --service-endpoint-configuration ./ServiceConnectionGeneric.json

Setelah pembuatan berhasil, ditetapkan Id ke titik akhir layanan dan respons yang mirip dengan sintaks berikut dikembalikan.

{
  "administratorsGroup": null,
  "authorization": {
    "parameters": {
      "password": null,
      "username": "myusername"
    },
    "scheme": "UsernamePassword"
  },
  "createdBy": {
    "descriptor": "aad.OGYxZTFlODEtMGJiNC03N2ZkLThkYzUtYjE3MTNiNTQ2MjQ4",
    "directoryAlias": null,
    "displayName": "Jamal Hartnett",
    "id": "60c83423-4eb6-4c5e-8395-1e71cb4aef4c",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.OGYxZTFlODEtMGJiNC03N2ZkLThkYzUtYjE3MTNiNTQ2MjQ4",
    "inactive": null,
    "isAadIdentity": null,
    "isContainer": null,
    "isDeletedInOrigin": null,
    "profileUrl": null,
    "uniqueName": "fabrikamfiber4@hotmail.com",
    "url": "https://spsprodwcus0.vssps.visualstudio.com/A0214b8cc-a36c-4b93-abbf-6348473c2f0a/_apis/Identities/60c83423-4eb6-4c5e-8395-1e71cb4aef4c"
  },
  "data": {},
  "description": null,
  "groupScopeId": null,
  "id": "3b6890ef-54b3-47ec-a907-a5d2f96237da",
  "isReady": true,
  "isShared": false,
  "name": "MyNewServiceEndpoint",
  "operationStatus": null,
  "owner": "library",
  "readersGroup": null,
  "serviceEndpointProjectReferences": [
    {
      "name": "MyNewServiceEndpoint",
      "projectReference": {
        "id": "677da0fb-b067-4f77-b89b-f32c12bb8617",
        "name": null
      }
    }
  ],
  "type": "Generic",
  "url": "https://myserver"
}

Membuat titik akhir layanan GitHub

Untuk membuat titik akhir layanan GitHub, gunakan az devops service-endpoint github create perintah :

az devops service-endpoint github create --github-url
                                         --name 
                                         [--org]
                                         [--project]

Dalam mode interaktif, az devops service-endpoint github create perintah meminta token PAT GitHub menggunakan pesan perintah, untuk tujuan otomatisasi, atur token PAT GitHub menggunakan AZURE_DEVOPS_EXT_GITHUB_PAT variabel lingkungan. Untuk informasi selengkapnya, lihat Masuk dengan token akses pribadi (PAT).

Membuat titik akhir layanan Azure Resource Manager

Untuk membuat titik akhir layanan Azure Resource Manager, gunakan az devops service-endpoint azurerm create perintah .

az devops service-endpoint azurerm create --azure-rm-service-principal-id
                                          --azure-rm-subscription-id
                                          --azure-rm-subscription-name
                                          --azure-rm-tenant-id
                                          --name
                                          [--azure-rm-service-principal-certificate-path] 
                                          [--org]
                                          [--project]

Menggunakan rahasia/kata sandi klien

Dalam mode interaktif, az devops service-endpoint azurerm create perintah meminta kata sandi/rahasia perwakilan layanan menggunakan pesan perintah. Untuk tujuan otomatisasi, atur kata sandi/rahasia perwakilan layanan menggunakan AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY variabel lingkungan.

export AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY=<your_secret_here>

$env:AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY=<your_secret_here>

Menggunakan sertifikat klien

Jika aplikasi Microsoft Entra menggunakan sertifikat untuk autentikasi, buat file .pem untuk sertifikat dan teruskan jalur ke file .pem menggunakan --azure-rm-service-principal-certificate-path argumen .

Anda dapat membuat file a.pem menggunakan openssl:

openssl pkcs12 -in file.pfx -out file.pem -nodes -password pass:<password_here>