WorkspaceApi interface
WorkspaceApi'yi temsil eden arabirim.
Yöntemler
Yöntem Ayrıntıları
beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Bir API Management hizmet örneğinde çalışma alanının belirtilen API'sini yeni oluşturur veya güncelleştirir.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
- parameters
- ApiCreateOrUpdateParameter
Parametreleri oluşturun veya güncelleştirin.
Seçenekler parametreleri.
Döndürülenler
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Bir API Management hizmet örneğinde çalışma alanının belirtilen API'sini yeni oluşturur veya güncelleştirir.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
- parameters
- ApiCreateOrUpdateParameter
Parametreleri oluşturun veya güncelleştirin.
Seçenekler parametreleri.
Döndürülenler
Promise<WorkspaceApiCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)
Bir API Management hizmet örneğinde çalışma alanının belirtilen API'sini siler.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): Promise<void>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
- ifMatch
-
string
Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır.
- options
- WorkspaceApiDeleteOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<void>
get(string, string, string, string, WorkspaceApiGetOptionalParams)
Tanımlayıcısı tarafından belirtilen API'nin ayrıntılarını alır.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
- options
- WorkspaceApiGetOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<WorkspaceApiGetResponse>
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)
Tanımlayıcısı tarafından belirtilen API'nin varlık durumu (Etag) sürümünü alır.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Seçenekler parametreleri.
Döndürülenler
Promise<WorkspaceApiGetEntityTagHeaders>
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)
Bir API Management hizmet örneğindeki çalışma alanının tüm API'lerini listeler.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
Seçenekler parametreleri.
Döndürülenler
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)
Bir API Management hizmet örneğinde çalışma alanının belirtilen API'sini güncelleştirir.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>Parametreler
- resourceGroupName
-
string
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
- serviceName
-
string
API Management hizmetinin adı.
- workspaceId
-
string
Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
- apiId
-
string
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
- ifMatch
-
string
Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır.
- parameters
- ApiUpdateContract
API Güncelleştirme Sözleşmesi parametreleri.
- options
- WorkspaceApiUpdateOptionalParams
Seçenekler parametreleri.
Döndürülenler
Promise<WorkspaceApiUpdateResponse>