WorkspaceApiVersionSet interface
Interfejs reprezentujący zestaw WorkspaceApiVersionSet.
Metody
Szczegóły metody
createOrUpdate(string, string, string, string, ApiVersionSetContract, WorkspaceApiVersionSetCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje zestaw wersji interfejsu API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, versionSetId: string, parameters: ApiVersionSetContract, options?: WorkspaceApiVersionSetCreateOrUpdateOptionalParams): Promise<WorkspaceApiVersionSetCreateOrUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- versionSetId
-
string
Identyfikator zestawu wersji interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- ApiVersionSetContract
Tworzenie lub aktualizowanie parametrów.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, WorkspaceApiVersionSetDeleteOptionalParams)
Usuwa określony zestaw wersji interfejsu API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, versionSetId: string, ifMatch: string, options?: WorkspaceApiVersionSetDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- versionSetId
-
string
Identyfikator zestawu wersji interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, WorkspaceApiVersionSetGetOptionalParams)
Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, versionSetId: string, options?: WorkspaceApiVersionSetGetOptionalParams): Promise<WorkspaceApiVersionSetGetResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- versionSetId
-
string
Identyfikator zestawu wersji interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
Promise<WorkspaceApiVersionSetGetResponse>
getEntityTag(string, string, string, string, WorkspaceApiVersionSetGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) zestawu wersji interfejsu API określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, versionSetId: string, options?: WorkspaceApiVersionSetGetEntityTagOptionalParams): Promise<WorkspaceApiVersionSetGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- versionSetId
-
string
Identyfikator zestawu wersji interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
listByService(string, string, string, WorkspaceApiVersionSetListByServiceOptionalParams)
Wyświetla kolekcję zestawów wersji interfejsu API w określonym obszarze roboczym z wystąpieniem usługi.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiVersionSetListByServiceOptionalParams): PagedAsyncIterableIterator<ApiVersionSetContract, ApiVersionSetContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.
Zwraca
update(string, string, string, string, string, ApiVersionSetUpdateParameters, WorkspaceApiVersionSetUpdateOptionalParams)
Aktualizuje szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, versionSetId: string, ifMatch: string, parameters: ApiVersionSetUpdateParameters, options?: WorkspaceApiVersionSetUpdateOptionalParams): Promise<WorkspaceApiVersionSetUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- workspaceId
-
string
Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- versionSetId
-
string
Identyfikator zestawu wersji interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- ApiVersionSetUpdateParameters
Aktualizuj parametry.
Parametry opcji.
Zwraca
Promise<WorkspaceApiVersionSetUpdateResponse>