ProductApi interface
Schnittstelle, die eine ProductApi darstellt.
Methoden
| check |
Überprüft, ob die durch Bezeichner angegebene API-Entität der Product-Entität zugeordnet ist. |
| create |
Fügt dem angegebenen Produkt eine API hinzu |
| delete(string, string, string, string, Product |
Löscht die angegebene API aus dem angegebenen Produkt |
| list |
Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind |
Details zur Methode
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Überprüft, ob die durch Bezeichner angegebene API-Entität der Product-Entität zugeordnet ist.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- productId
-
string
Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
Die Optionsparameter.
Gibt zurück
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Fügt dem angegebenen Produkt eine API hinzu
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- productId
-
string
Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
Die Optionsparameter.
Gibt zurück
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Löscht die angegebene API aus dem angegebenen Produkt
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- productId
-
string
Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
- apiId
-
string
API-Revisionsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.
- options
- ProductApiDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Listet eine Auflistung von APIs auf, die einem Produkt zugeordnet sind
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- productId
-
string
Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
Die Optionsparameter.