Group interface
Interfejs reprezentujący grupę.
Metody
| create |
Tworzy lub aktualizuje grupę. |
| delete(string, string, string, string, Group |
Usuwa określoną grupę wystąpienia usługi API Management. |
| get(string, string, string, Group |
Pobiera szczegóły grupy określonej przez jej identyfikator. |
| get |
Pobiera wersję stanu jednostki (Etag) grupy określonej przez jej identyfikator. |
| list |
Wyświetla kolekcję grup zdefiniowanych w wystąpieniu usługi. |
| update(string, string, string, string, Group |
Aktualizuje szczegóły grupy określonej przez jej identyfikator. |
Szczegóły metody
createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje grupę.
function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- GroupCreateParameters
Utwórz parametry.
Parametry opcji.
Zwraca
Promise<GroupCreateOrUpdateResponse>
delete(string, string, string, string, GroupDeleteOptionalParams)
Usuwa określoną grupę wystąpienia usługi API Management.
function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. 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.
- options
- GroupDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, GroupGetOptionalParams)
Pobiera szczegóły grupy określonej przez jej identyfikator.
function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- GroupGetOptionalParams
Parametry opcji.
Zwraca
Promise<GroupGetResponse>
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) grupy określonej przez jej identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- GroupGetEntityTagOptionalParams
Parametry opcji.
Zwraca
Promise<GroupGetEntityTagHeaders>
listByService(string, string, GroupListByServiceOptionalParams)
Wyświetla kolekcję grup zdefiniowanych w wystąpieniu usługi.
function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- options
- GroupListByServiceOptionalParams
Parametry opcji.
Zwraca
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)
Aktualizuje szczegóły grupy określonej przez jej identyfikator.
function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- groupId
-
string
Identyfikator grupy. 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
- GroupUpdateParameters
Aktualizuj parametry.
- options
- GroupUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<GroupUpdateResponse>