Endpoints - Create

リファレンス

Service:: Service Endpoint

API Version:: 7.1-preview.4

新しいサービスエンドポイントを作成します

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1-preview.4

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.4' に設定する必要があります。

要求本文

名前	型	説明
administratorsGroup	IdentityRef	これは非推奨のフィールドです。
authorization	EndpointAuthorization	エンドポイントと通信するための承認データを取得または設定します。
createdBy	IdentityRef	サービスエンドポイントを作成したユーザーの ID 参照を取得または設定します。
data	object
description	string	エンドポイントの説明を取得または設定します。
groupScopeId	string	これは非推奨のフィールドです。
id	string	このエンドポイントの識別子を取得または設定します。
isReady	boolean	EndPoint 状態インジケーター
isShared	boolean	サービスエンドポイントが他のプロジェクトと共有されているかどうかを示します。
name	string	エンドポイントのフレンドリ名を取得または設定します。
operationStatus	JObject	エンドポイントの作成/削除中のエラーメッセージ
owner	string	エンドポイントの所有者サポートされている値は、"library"、"agentcloud" です
readersGroup	IdentityRef	サービスエンドポイントの閲覧者グループの ID 参照を取得または設定します。
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	サービスエンドポイントが共有されている他のすべてのプロジェクト参照。
type	string	エンドポイントの種類を取得します。値の設定も可能です。
url	string	エンドポイントの URL を取得または設定します。

応答

名前	型	説明
200 OK	ServiceEndpoint	成功した操作

セキュリティ

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名前	説明
vso.serviceendpoint_manage	サービスエンドポイントの読み取り、クエリ、管理を行う機能を付与します。

例

Create Azure RM service endpoint

Create service endpoint

Create Azure RM service endpoint

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1-preview.4

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": "SomePassword"
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Sample Response

Status code:: 200

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "id": "1dfdea68-9549-409e-abee-c5da69cfec5f",
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
      }
    },
    "id": "e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
    "uniqueName": "anpuri@outlook-int.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": null
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "owner": "library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Create service endpoint

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1-preview.4

{
  "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"
    }
  ]
}

Sample Response

Status code:: 200

{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "MyNewServiceEndpoint",
  "type": "Generic",
  "url": "https://myserver",
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
      }
    },
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "username": "myusername",
      "password": null
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "owner": "library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

定義

名前	説明
EndpointAuthorization	サービスエンドポイントに使用される承認を表します。
IdentityRef
JObject	JSON オブジェクトを表します。
JToken	抽象 JSON トークンを表します。
ProjectReference
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
ServiceEndpoint	オーケストレーションジョブで使用できるエンドポイントを表します。
ServiceEndpointProjectReference

EndpointAuthorization

サービスエンドポイントに使用される承認を表します。

名前	型	説明
parameters	object	選択した承認スキームのパラメーターを取得または設定します。
scheme	string	サービスエンドポイント認証に使用されるスキームを取得または設定します。

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている Graph ユーザーに対してクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" 辞書の "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用する
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

JObject

JSON オブジェクトを表します。

名前	型	説明
item	JToken	抽象 JSON トークンを表します。
type	string	この JToken のノードの種類を取得します。

JToken

抽象 JSON トークンを表します。

名前	型	説明
first	JToken	このトークンの最初の子トークンを取得します。
hasValues	boolean	このトークンに子トークンがあるかどうかを示す値を取得します。
item	JToken	抽象 JSON トークンを表します。
last	JToken	このトークンの最後の子トークンを取得します。
next	JToken	このノードの次の兄弟トークンを取得します。
parent	string	親を取得または設定します。
path	string	JSON トークンのパスを取得します。
previous	JToken	このノードの前の兄弟トークンを取得します。
root	JToken	この JToken のルート JToken を取得します。
type	string	この JToken のノードの種類を取得します。

ProjectReference

名前	型	説明
id	string
name	string

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

ServiceEndpoint

オーケストレーションジョブで使用できるエンドポイントを表します。

名前	型	説明
administratorsGroup	IdentityRef	これは非推奨のフィールドです。
authorization	EndpointAuthorization	エンドポイントと通信するための承認データを取得または設定します。
createdBy	IdentityRef	サービスエンドポイントを作成したユーザーの ID 参照を取得または設定します。
data	object
description	string	エンドポイントの説明を取得または設定します。
groupScopeId	string	これは非推奨のフィールドです。
id	string	このエンドポイントの識別子を取得または設定します。
isReady	boolean	EndPoint 状態インジケーター
isShared	boolean	サービスエンドポイントが他のプロジェクトと共有されているかどうかを示します。
name	string	エンドポイントのフレンドリ名を取得または設定します。
operationStatus	JObject	エンドポイントの作成/削除中のエラーメッセージ
owner	string	エンドポイントの所有者サポートされている値は、"library"、"agentcloud" です
readersGroup	IdentityRef	サービスエンドポイントの閲覧者グループの ID 参照を取得または設定します。
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	サービスエンドポイントが共有されている他のすべてのプロジェクト参照。
type	string	エンドポイントの種類を取得します。値の設定も可能です。
url	string	エンドポイントの URL を取得または設定します。

ServiceEndpointProjectReference

名前	型	説明
description	string	サービスエンドポイントの説明を取得または設定します。
name	string	サービスエンドポイントの名前を取得または設定します。
projectReference	ProjectReference	サービスエンドポイントのプロジェクト参照を取得または設定します。

次の方法で共有

Endpoints - Create

URI パラメーター

要求本文

応答

セキュリティ

oauth2

Scopes

例

Create Azure RM service endpoint

Sample Request

Sample Response

Create service endpoint

Sample Request

Sample Response

定義

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference

その他のリソース