Backend - Update
Atualizações um back-end existente.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
backend
|
path | True |
string |
Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Padrão Regex: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
If-Match | True |
string |
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
properties.credentials |
Propriedades do contrato de credenciais de back-end |
|
properties.description |
string |
Descrição do back-end. |
properties.properties |
Contrato de propriedades de back-end |
|
properties.protocol |
Protocolo de comunicação de back-end. |
|
properties.proxy |
Propriedades do contrato do gateway de back-end |
|
properties.resourceId |
string |
Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. |
properties.title |
string |
Título de back-end. |
properties.tls |
Propriedades do TLS de back-end |
|
properties.url |
string |
Url de runtime do back-end. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
O back-end existente foi atualizado com êxito. Cabeçalhos ETag: string |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
ApiManagementUpdateBackend
Solicitação de exemplo
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2022-08-01
{
"properties": {
"description": "description5308",
"tls": {
"validateCertificateChain": false,
"validateCertificateName": true
}
}
}
Resposta de exemplo
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "proxybackend",
"properties": {
"description": "description5308",
"url": "https://backendname2644/",
"protocol": "http",
"credentials": {
"query": {
"sv": [
"xx",
"bb",
"cc"
]
},
"header": {
"x-my-1": [
"val1",
"val2"
]
},
"authorization": {
"scheme": "Basic",
"parameter": "opensesma"
}
},
"proxy": {
"url": "http://192.168.1.1:8080",
"username": "Contoso\\admin",
"password": "<password>"
},
"tls": {
"validateCertificateChain": false,
"validateCertificateName": true
}
}
}
Definições
Nome | Description |
---|---|
Backend |
Informações de cabeçalho de autorização. |
Backend |
Detalhes do back-end. |
Backend |
Detalhes das Credenciais usadas para se conectar ao Back-end. |
Backend |
Propriedades específicas para o Tipo de Back-end. |
Backend |
Protocolo de comunicação de back-end. |
Backend |
Detalhes do Servidor WebProxy de Back-end a ser usado na Solicitação para Back-end. |
Backend |
Propriedades do back-end de tipo do Service Fabric. |
Backend |
Propriedades que controlam a validação do certificado TLS. |
Backend |
Parâmetros de atualização de back-end. |
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
X509Certificate |
Propriedades do servidor X509Names. |
BackendAuthorizationHeaderCredentials
Informações de cabeçalho de autorização.
Nome | Tipo | Description |
---|---|---|
parameter |
string |
Valor do parâmetro de autenticação. |
scheme |
string |
Nome do esquema de autenticação. |
BackendContract
Detalhes do back-end.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.credentials |
Propriedades do contrato de credenciais de back-end |
|
properties.description |
string |
Descrição do back-end. |
properties.properties |
Contrato de propriedades de back-end |
|
properties.protocol |
Protocolo de comunicação de back-end. |
|
properties.proxy |
Propriedades do contrato do gateway de back-end |
|
properties.resourceId |
string |
Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. |
properties.title |
string |
Título de back-end. |
properties.tls |
Propriedades do TLS de back-end |
|
properties.url |
string |
Url de runtime do back-end. |
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
Detalhes das Credenciais usadas para se conectar ao Back-end.
Nome | Tipo | Description |
---|---|---|
authorization |
Autenticação de cabeçalho de autorização |
|
certificate |
string[] |
Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos. |
certificateIds |
string[] |
Lista de IDs de certificado do cliente. |
header |
object |
Descrição do parâmetro de cabeçalho. |
query |
object |
Descrição do parâmetro de consulta. |
BackendProperties
Propriedades específicas para o Tipo de Back-end.
Nome | Tipo | Description |
---|---|---|
serviceFabricCluster |
Propriedades do cluster do Service Fabric de back-end |
BackendProtocol
Protocolo de comunicação de back-end.
Nome | Tipo | Description |
---|---|---|
http |
string |
O back-end é um serviço RESTful. |
soap |
string |
O back-end é um serviço SOAP. |
BackendProxyContract
Detalhes do Servidor WebProxy de Back-end a ser usado na Solicitação para Back-end.
Nome | Tipo | Description |
---|---|---|
password |
string |
Senha para se conectar ao Servidor WebProxy |
url |
string |
Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. |
username |
string |
Nome de usuário para se conectar ao servidor WebProxy |
BackendServiceFabricClusterProperties
Propriedades do back-end de tipo do Service Fabric.
Nome | Tipo | Description |
---|---|---|
clientCertificateId |
string |
A ID do certificado do cliente para o ponto de extremidade de gerenciamento. |
clientCertificatethumbprint |
string |
A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Serão ignorados se certificatesIds forem fornecidos |
managementEndpoints |
string[] |
O ponto de extremidade de gerenciamento de cluster. |
maxPartitionResolutionRetries |
integer |
Número máximo de repetições ao tentar resolve a partição. |
serverCertificateThumbprints |
string[] |
Impressões digitais dos certificados que o serviço de gerenciamento de cluster usa para comunicação tls |
serverX509Names |
Coleção De Nomes de Certificado X509 do Servidor |
BackendTlsProperties
Propriedades que controlam a validação do certificado TLS.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. |
validateCertificateName |
boolean |
True |
Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. |
BackendUpdateParameters
Parâmetros de atualização de back-end.
Nome | Tipo | Description |
---|---|---|
properties.credentials |
Propriedades do contrato de credenciais de back-end |
|
properties.description |
string |
Descrição do back-end. |
properties.properties |
Contrato de propriedades de back-end |
|
properties.protocol |
Protocolo de comunicação de back-end. |
|
properties.proxy |
Propriedades do contrato do gateway de back-end |
|
properties.resourceId |
string |
Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. |
properties.title |
string |
Título de back-end. |
properties.tls |
Propriedades do TLS de back-end |
|
properties.url |
string |
Url de runtime do back-end. |
ErrorFieldContract
Contrato de campo de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
X509CertificateName
Propriedades do servidor X509Names.
Nome | Tipo | Description |
---|---|---|
issuerCertificateThumbprint |
string |
Impressão digital para o emissor do certificado. |
name |
string |
Nome Comum do Certificado. |