Aracılığıyla paylaş

OperationSpec interface

  • Başvuru
Paket:
@azure/core-http

İstek bilgilerinin ServiceClient tarafından döndürülebilir bir nesne yüküne doğru şekilde seri hale getirme ve yanıt bilgilerini seri durumdan çıkarma dahil olmak üzere HTTP üzerinde belirli bir hizmet işleminin nasıl gerçekleştirildiğini tanımlayan belirtim.

Özellikler

baseUrl

Hizmetin belirtiminde sağlanan URL. Bu, içinde tüm URL şablonu değişkenlerini kullanmaya devam eder. OperationSpec oluşturulduğunda bu sağlanmazsa, ServiceClient üzerindeki bir "baseUri" özelliğiyle doldurulur.
contentType

İstek gövdesinin içerik türü. Bu değer sağlanmışsa "Content-Type" üst bilgisi olarak kullanılır.
formDataParameters

İşlemin HTTP isteği için formdata gövdesi oluşturmak için kullanılacak işlem yönteminin parametreleri.
headerParameters

İşlemin HTTP isteğinde üst bilgilere dönüştürülecek işlem yöntemine yönelik parametreler.
httpMethod

Bu işlem için istekler tarafından kullanılması gereken HTTP yöntemi.
isXML

Bu işlemin XML isteği ve yanıt gövdelerini kullanıp kullanmadığı.
mediaType

İstek gövdesinin medya türü. Bu değer, sağlanırsa serileştirmede yardımcı olmak için kullanılabilir.
path

Bu işlemin URL'si için sabit yol. Bu, içinde tüm URL şablonu değişkenlerini kullanmaya devam eder.
queryParameters

Oluşturulacak URL'nin sorgusuna eklenecek işlem yöntemine yönelik parametreler.
requestBody

HTTP isteğinin gövdesini oluşturmak için kullanılacak parametre.
responses

Bu işlemin hangi durum kodunun döndürüldüğünü temel alarak döndürebileceği farklı yanıt türleri.
serializer

Bu işlemde kullanılacak seri hale getirici.
urlParameters

İşlem yönteminin, yapılandırılmış URL'ye değiştirilecek parametreleri.

Özellik Ayrıntıları

baseUrl

Hizmetin belirtiminde sağlanan URL. Bu, içinde tüm URL şablonu değişkenlerini kullanmaya devam eder. OperationSpec oluşturulduğunda bu sağlanmazsa, ServiceClient üzerindeki bir "baseUri" özelliğiyle doldurulur.

baseUrl?: string

Özellik Değeri

string

contentType

İstek gövdesinin içerik türü. Bu değer sağlanmışsa "Content-Type" üst bilgisi olarak kullanılır.

contentType?: string

Özellik Değeri

string

formDataParameters

İşlemin HTTP isteği için formdata gövdesi oluşturmak için kullanılacak işlem yönteminin parametreleri.

formDataParameters?: readonly OperationParameter[]

Özellik Değeri

readonly OperationParameter[]

headerParameters

İşlemin HTTP isteğinde üst bilgilere dönüştürülecek işlem yöntemine yönelik parametreler.

headerParameters?: readonly OperationParameter[]

Özellik Değeri

readonly OperationParameter[]

httpMethod

Bu işlem için istekler tarafından kullanılması gereken HTTP yöntemi.

httpMethod: HttpMethods

Özellik Değeri

HttpMethods

isXML

Bu işlemin XML isteği ve yanıt gövdelerini kullanıp kullanmadığı.

isXML?: boolean

Özellik Değeri

boolean

mediaType

İstek gövdesinin medya türü. Bu değer, sağlanırsa serileştirmede yardımcı olmak için kullanılabilir.

mediaType?: string

Özellik Değeri

string

path

Bu işlemin URL'si için sabit yol. Bu, içinde tüm URL şablonu değişkenlerini kullanmaya devam eder.

path?: string

Özellik Değeri

string

queryParameters

Oluşturulacak URL'nin sorgusuna eklenecek işlem yöntemine yönelik parametreler.

queryParameters?: readonly OperationQueryParameter[]

Özellik Değeri

readonly OperationQueryParameter[]

requestBody

HTTP isteğinin gövdesini oluşturmak için kullanılacak parametre.

requestBody?: OperationParameter

Özellik Değeri

OperationParameter

responses

Bu işlemin hangi durum kodunun döndürüldüğünü temel alarak döndürebileceği farklı yanıt türleri.

responses: {[responseCode: string]: OperationResponse}

Özellik Değeri

{[responseCode: string]: OperationResponse}

serializer

Bu işlemde kullanılacak seri hale getirici.

serializer: Serializer

Özellik Değeri

Serializer

urlParameters

İşlem yönteminin, yapılandırılmış URL'ye değiştirilecek parametreleri.

urlParameters?: readonly OperationURLParameter[]

Özellik Değeri

readonly OperationURLParameter[]