Endpoints - Update Service Endpoints

Referência

Service:: Service Endpoint

API Version:: 7.1-preview.4

Atualize os pontos de extremidade de serviço.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.4' para usar esta versão da API.

Corpo da solicitação

Nome	Tipo	Description
body	ServiceEndpoint[]	Nomes dos pontos de extremidade de serviço a serem atualizados.

Respostas

Nome	Tipo	Description
200 OK	ServiceEndpoint[]	operação bem-sucedida

Segurança

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

Nome	Description
vso.serviceendpoint_manage	Concede a capacidade de ler, consultar e gerenciar pontos de extremidade de serviço.

Exemplos

Update service endpoints

Sample Request

HTTP

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

[
  {
    "data": {},
    "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
    "name": "UpdatedMyNewServiceEndpoint",
    "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": "e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
      "uniqueName": "fabfiber@outlook.com",
      "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
      "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
    },
    "description": "",
    "authorization": {
      "parameters": {
        "username": "myusername"
      },
      "scheme": "UsernamePassword"
    },
    "isShared": false,
    "isReady": true,
    "owner": "Library",
    "serviceEndpointProjectReferences": [
      {
        "projectReference": {
          "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
          "name": "TestProject"
        },
        "name": "MyNewServiceEndpoint"
      }
    ]
  }
]

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "data": {},
      "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
      "name": "UpdatedMyNewServiceEndpoint",
      "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": "e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
        "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
      },
      "description": "",
      "authorization": {
        "parameters": {
          "username": "myusername"
        },
        "scheme": "UsernamePassword"
      },
      "isShared": false,
      "isReady": true,
      "owner": "Library",
      "serviceEndpointProjectReferences": [
        {
          "projectReference": {
            "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
            "name": "TestProject"
          },
          "name": "MyNewServiceEndpoint"
        }
      ]
    }
  ]
}

Definições

Nome	Description
EndpointAuthorization	Representa a autorização usada para o ponto de extremidade de serviço.
IdentityRef
JObject	Representa um objeto JSON.
JToken	Representa um token JSON abstrato.
ProjectReference
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ServiceEndpoint	Representa um ponto de extremidade que pode ser usado por um trabalho de orquestração.
ServiceEndpointProjectReference

EndpointAuthorization

Representa a autorização usada para o ponto de extremidade de serviço.

Nome	Tipo	Description
parameters	object	Obtém ou define os parâmetros para o esquema de autorização selecionado.
scheme	string	Obtém ou define o esquema usado para autenticação de ponto de extremidade de serviço.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
displayName	string	Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido - Disponível na entrada "avatar" do dicionário "_links" IdentityRef
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistidas de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

JObject

Representa um objeto JSON.

Nome	Tipo	Description
item	JToken	Representa um token JSON abstrato.
type	string	Obtém o tipo de nó para este JToken.

JToken

Representa um token JSON abstrato.

Nome	Tipo	Description
first	JToken	Obtenha o primeiro token filho desse token.
hasValues	boolean	Obtém um valor que indica se esse token tem tokens filho.
item	JToken	Representa um token JSON abstrato.
last	JToken	Obtenha o último token filho desse token.
next	JToken	Obtém o próximo token irmão desse nó.
parent	string	Obtém ou define o pai.
path	string	Obtém o caminho do token JSON.
previous	JToken	Obtém o token irmão anterior desse nó.
root	JToken	Obtém o JToken raiz desse JToken.
type	string	Obtém o tipo de nó para este JToken.

ProjectReference

Nome	Tipo	Description
id	string
name	string

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

ServiceEndpoint

Representa um ponto de extremidade que pode ser usado por um trabalho de orquestração.

Nome	Tipo	Description
administratorsGroup	IdentityRef	Este é um campo preterido.
authorization	EndpointAuthorization	Obtém ou define os dados de autorização para falar com o ponto de extremidade.
createdBy	IdentityRef	Obtém ou define a referência de identidade para o usuário que criou o ponto de extremidade de serviço.
data	object
description	string	Obtém ou define a descrição do ponto de extremidade.
groupScopeId	string	Este é um campo preterido.
id	string	Obtém ou define o identificador desse ponto de extremidade.
isReady	boolean	Indicador de estado do Ponto de Extremidade
isShared	boolean	Indica se o ponto de extremidade de serviço é compartilhado com outros projetos ou não.
name	string	Obtém ou define o nome amigável do ponto de extremidade.
operationStatus	JObject	Mensagem de erro durante a criação/exclusão do ponto de extremidade
owner	string	Proprietário do ponto de extremidade Os valores com suporte são "library", "agentcloud"
readersGroup	IdentityRef	Obtém ou define a referência de identidade para o grupo de leitores do ponto de extremidade de serviço.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Todas as outras referências de projeto em que o ponto de extremidade de serviço é compartilhado.
type	string	Obtém ou define o tipo do ponto de extremidade.
url	string	Obtém ou define a URL do ponto de extremidade.

ServiceEndpointProjectReference

Nome	Tipo	Description
description	string	Obtém ou define a descrição do ponto de extremidade de serviço.
name	string	Obtém ou define o nome do ponto de extremidade de serviço.
projectReference	ProjectReference	Obtém ou define a referência de projeto do ponto de extremidade de serviço.

Compartilhar via