WorkspaceApi interface
Antarmuka yang mewakili WorkspaceApi.
Metode
Detail Metode
beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Membuat BARU atau memperbarui API ruang kerja tertentu yang ada dalam instans layanan API Management.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
- parameters
- ApiCreateOrUpdateParameter
Membuat atau memperbarui parameter.
Parameter opsi.
Mengembalikan
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)
Membuat BARU atau memperbarui API ruang kerja tertentu yang ada dalam instans layanan API Management.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
- parameters
- ApiCreateOrUpdateParameter
Membuat atau memperbarui parameter.
Parameter opsi.
Mengembalikan
Promise<WorkspaceApiCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)
Menghapus API ruang kerja yang ditentukan dalam instans layanan API Management.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, options?: WorkspaceApiDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- options
- WorkspaceApiDeleteOptionalParams
Parameter opsi.
Mengembalikan
Promise<void>
get(string, string, string, string, WorkspaceApiGetOptionalParams)
Mendapatkan detail API yang ditentukan oleh pengidentifikasinya.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
- options
- WorkspaceApiGetOptionalParams
Parameter opsi.
Mengembalikan
Promise<WorkspaceApiGetResponse>
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)
Mendapatkan versi status entitas (Etag) dari API yang ditentukan oleh pengidentifikasinya.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
Parameter opsi.
Mengembalikan
Promise<WorkspaceApiGetEntityTagHeaders>
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)
Mencantumkan semua API ruang kerja dalam instans layanan API Management.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
Parameter opsi.
Mengembalikan
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)
Memperbarui API ruang kerja yang ditentukan dalam instans layanan API Management.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>Parameter
- resourceGroupName
-
string
Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
- serviceName
-
string
Nama layanan API Management.
- workspaceId
-
string
Pengidentifikasi ruang kerja. Harus unik dalam instans layanan API Management saat ini.
- apiId
-
string
Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
- ifMatch
-
string
ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.
- parameters
- ApiUpdateContract
Parameter Kontrak Pembaruan API.
- options
- WorkspaceApiUpdateOptionalParams
Parameter opsi.
Mengembalikan
Promise<WorkspaceApiUpdateResponse>