ApiTagDescription interface
Interfejs reprezentujący element ApiTagDescription.
Metody
| create |
Tworzenie/aktualizowanie opisu tagu w zakresie interfejsu API. |
| delete(string, string, string, string, string, Api |
Usuń opis tagu dla interfejsu API. |
| get(string, string, string, string, Api |
Pobieranie opisu tagu w zakresie interfejsu API |
| get |
Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator. |
| list |
Wyświetla listę wszystkich opisów tagów w zakresie interfejsu API. Model podobny do struktury Swagger — tagDescription jest zdefiniowany na poziomie interfejsu API, ale tag może być przypisany do operacji |
Szczegóły metody
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Tworzenie/aktualizowanie opisu tagu w zakresie interfejsu API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
- tagDescriptionId
-
string
Identyfikator opisu tagu. Używany podczas tworzenia tagDescription dla skojarzenia interfejsu API/tagu. Na podstawie nazw interfejsów API i tagów.
- parameters
- TagDescriptionCreateParameters
Utwórz parametry.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Usuń opis tagu dla interfejsu API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
- tagDescriptionId
-
string
Identyfikator opisu tagu. Używany podczas tworzenia tagDescription dla skojarzenia interfejsu API/tagu. Na podstawie nazw interfejsów API i tagów.
- 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, ApiTagDescriptionGetOptionalParams)
Pobieranie opisu tagu w zakresie interfejsu API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
- tagDescriptionId
-
string
Identyfikator opisu tagu. Używany podczas tworzenia tagDescription dla skojarzenia interfejsu API/tagu. Na podstawie nazw interfejsów API i tagów.
Parametry opcji.
Zwraca
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki tagu określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
- tagDescriptionId
-
string
Identyfikator opisu tagu. Używany podczas tworzenia tagDescription dla skojarzenia interfejsu API/tagu. Na podstawie nazw interfejsów API i tagów.
Parametry opcji.
Zwraca
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Wyświetla listę wszystkich opisów tagów w zakresie interfejsu API. Model podobny do struktury Swagger — tagDescription jest zdefiniowany na poziomie interfejsu API, ale tag może być przypisany do operacji
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
Parametry opcji.