Punkt końcowy usługi interfejsu wiersza polecenia usługi Azure DevOps

Azure DevOps Services

Połączenie z usługą umożliwia usłudze Azure DevOps komunikowanie się z usługą zewnętrzną, taką jak Azure, Bitbucket, Kubernetes, Maven i GitHub. az devops service-endpoint Za pomocą polecenia można tworzyć różne typy połączeń usług i zarządzać nimi. Można wykonać następujące zadania:

• Tworzenie punktu końcowego usługi przy użyciu pliku konfiguracji
• Aktualizowanie punktu końcowego usługi
• Zarządzanie punktami końcowymi i połączeniami usługi GitHub
• Zarządzanie punktami końcowymi i połączeniami usługi Azure Resource Manager
• Wyświetlanie listy punktów końcowych usługi zdefiniowanych dla projektu
• Uzyskaj szczegóły punktu końcowego usługi

Aby uzyskać szczegółową składnię poleceń, zobacz az devops service-endpoint. Aby uzyskać składnię interfejsu API REST dla punktów końcowych usługi, zobacz Punkty końcowe.

Możesz użyć poleceń Azure CLI, aby uzyskać szczegółowe informacje, wylistować, usunąć i zaktualizować punkt końcowy usługi. Zobacz Punkty końcowe usługi lub połączenia usługi.

Aby użyć portalu internetowego do tworzenia i edytowania połączeń usług, zobacz Zarządzanie połączeniami usług.

Tworzenie punktu końcowego usługi przy użyciu pliku konfiguracji

Aby utworzyć punkt końcowy usługi przy użyciu pliku konfiguracji, najpierw zdefiniuj plik konfiguracji. Zawartość pliku konfiguracji różni się w zależności od typu połączenia, takiego jak Azure Classic, Azure Data Explorer, Bitbucket Cloud lub Chef.

Format pliku konfiguracji

Poniższa składnia przedstawia format JSON dla pliku konfiguracji.

{
  "data": {},
  "name": "MyNewServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "authorization": {
    "parameters": {
      "tenantid": "your-tenant-id"
    },
    "scheme": "ManagedServiceIdentity"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

W poniższej tabeli opisano każdy parametr. Parametr type obsługuje tworzenie dowolnego typu punktu końcowego usługi.

Aby uzyskać listę obsługiwanych typów i ich wymaganych parametrów wejściowych, zapoznaj się z następującym wpisem interfejsu API REST:

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

Opis typów połączeń i parametrów usługi można znaleźć w temacie Common service connection types (Typowe typy połączeń usługi).

Uruchamianie polecenia create

Punkt końcowy usługi można utworzyć za pomocą polecenia az devops service-endpoint create .

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

Parametry

• service-endpoint-configuration: wymagane. json Nazwa pliku konfiguracji z konfiguracją punktu końcowego usługi.
• kodowanie: opcjonalne. Kodowanie pliku wejściowego. Wartość domyślna to utf-8. Zaakceptowane wartości: ascii, , utf-16beutf-16le, utf-8.
• organizacja: adres URL organizacji usługi Azure DevOps. Domyślną organizację można skonfigurować przy użyciu polecenia az devops configure --defaults organization=ORG_URL. Wymagane, jeśli nie skonfigurowano jako domyślne.
• projekt: nazwa lub identyfikator projektu. Projekt domyślny można skonfigurować przy użyciu polecenia az devops configure --defaults project=NAME_OR_ID. Wymagane, jeśli nie skonfigurowano jako domyślne.

Przykład

Następujące polecenie tworzy połączenie usługi odwołujące się do pliku ServiceConnectionGeneric.json .

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

Po utworzeniu polecenie przypisuje element Id do punktu końcowego usługi. Ten przykład zwraca następujący wynik.

{
  "administratorsGroup": null,
  "authorization": {
    "parameters": {
      "serviceprincipalid": "your-service-principal-id",
      "serviceprincipalkey": "your-service-principal-key",
      "tenantid": "your-tenant-id"
    },
    "scheme": "ServicePrincipal"
  },
  "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"
}

Tworzenie punktu końcowego usługi GitHub

Aby utworzyć punkt końcowy usługi GitHub, użyj polecenia az devops service-endpoint github create :

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

W trybie az devops service-endpoint github create interaktywnym polecenie wyświetla monit o token PAT usługi GitHub. W celu automatyzacji ustawienia tokenu PAT GitHub, użyj zmiennej środowiskowej AZURE_DEVOPS_EXT_GITHUB_PAT. Aby uzyskać więcej informacji, zobacz Logowanie się przy użyciu osobistego tokenu dostępu.

Tworzenie punktu końcowego usługi Azure Resource Manager

Aby utworzyć punkt końcowy usługi Azure Resource Manager, użyj polecenia az devops service-endpoint azurerm create .

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] 
                                          [--organization]
                                          [--project]

Użyj tajemnicy klienta

W trybie interaktywnym polecenie az devops service-endpoint azurerm create wyświetla monit o tajny element główny usługi. Dla celów automatyzacji ustaw tajny klucz kontrahenta usługi, używając zmiennej środowiskowej AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY.

export AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY=<your_secret_here>

$env:AZURE_DEVOPS_EXT_AZURE_RM_SERVICE_PRINCIPAL_KEY=<your_secret_here>

Używanie certyfikatu klienta

Jeśli aplikacja Microsoft Entra używa certyfikatu do uwierzytelniania, utwórz plik pem dla certyfikatu. Przekaż ścieżkę do pliku pem przy użyciu argumentu --azure-rm-service-principal-certificate-path .

Plik pem można utworzyć przy użyciu biblioteki OpenSSL:

openssl pkcs12 -in file.pfx -out file.pem -nodes -secret pass:<secret_here>

Treści powiązane

• Zarządzanie połączeniami z usługami
• Nawiązywanie połączenia z platformą Azure przy użyciu połączenia usługi Azure Resource Manager
• az devops punkty końcowe usługi
• Interfejs API REST punktów końcowych