O Auth Providers - Create Or Update

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Cria ou atualiza um recurso oauthProvider.

PATCH {endpoint}/oauth/providers/{oauthProviderId}?api-version=2023-11-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
oauthProviderId	path	True	string	ID do recurso oauthProvider.
api-version	query	True	string	A versão da API solicitada

Cabeçalho da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Corpo da solicitação

Media Types: "application/merge-patch+json"

Nome	Tipo	Description
apiKey	string	Chave de API OAuth para determinado Provedor. Observação: atualmente aplicável ao provedor de clima. Não será enviado em resposta.
appId	string	aplicativo OAuth ID para determinado provedor OAuth.
appSecret	string	aplicativo OAuth segredo para determinado Provedor. Observação: não será enviado em resposta.
description	string	Descrição textual do recurso.
isProductionApp	boolean	Um sinalizador opcional para determinar se o Aplicativo está pronto para ser usado para cenários de produção no lado do provedor ou não. (Valor padrão: false) Observação: atualmente aplicável a JohnDeere.
name	string	Nome para identificar o recurso.
properties		Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ).

Respostas

Nome	Tipo	Description
200 OK	OAuthProvider	Êxito
201 Created	OAuthProvider	Criado
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

OAuthProviders_CreateOrUpdate

Solicitação de exemplo

HTTP

PATCH {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

Resposta de exemplo

Código de status:

200

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Código de status:

201

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

Definições

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
OAuthProvider	Esquema do recurso do provedor OAuth.

Error

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico do que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

OAuthProvider

Esquema do recurso do provedor OAuth.

Nome	Tipo	Valor padrão	Description
apiKey	string		Chave de API OAuth para determinado Provedor. Observação: atualmente aplicável ao provedor de clima. Não será enviado em resposta.
appId	string		aplicativo OAuth ID para determinado provedor OAuth.
appSecret	string		aplicativo OAuth segredo para determinado Provedor. Observação: não será enviado em resposta.
createdBy	string		Criado por ID de usuário/locatário.
createdDateTime	string		Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
description	string		Descrição textual do recurso.
eTag	string		O valor ETag para implementar simultaneidade otimista.
id	string		ID exclusiva do provedor OAuth.
isProductionApp	boolean	False	Um sinalizador opcional para determinar se o Aplicativo está pronto para ser usado para cenários de produção no lado do provedor ou não. (Valor padrão: false) Observação: atualmente aplicável a JohnDeere.
modifiedBy	string		Modificado por ID de usuário/locatário.
modifiedDateTime	string		Data e hora em que o recurso foi modificado pela última vez; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.
name	string		Nome para identificar o recurso.
properties			Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ).