Product interface
Schnittstelle, die ein Produkt darstellt.
Methoden
| create |
Erstellt oder aktualisiert ein Produkt |
| delete(string, string, string, string, Product |
Löscht das Produkt |
| get(string, string, string, Product |
Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben wird. |
| get |
Ruft die Entitätsstatusversion (Etag) des Produkts ab, das durch den Bezeichner angegeben wird. |
| list |
Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf |
| list |
Listet eine Auflistung von Produkten auf, denen Tags zugeordnet sind |
| update(string, string, string, string, Product |
Aktualisieren Sie vorhandene Produktdetails. |
Details zur Methode
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert ein Produkt
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>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.
- parameters
- ProductContract
Erstellen oder Aktualisieren von Parametern
Die Optionsparameter.
Gibt zurück
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
Löscht das Produkt
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): 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.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.
- options
- ProductDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, ProductGetOptionalParams)
Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>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.
- options
- ProductGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) des Produkts ab, das durch den Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>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.
Gibt zurück
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
Listet eine Auflistung der Produkte in der angegebenen Dienstinstanz auf
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], 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.
Die Optionsparameter.
Gibt zurück
listByTags(string, string, ProductListByTagsOptionalParams)
Listet eine Auflistung von Produkten auf, denen Tags zugeordnet sind
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], 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.
- options
- ProductListByTagsOptionalParams
Die Optionsparameter.
Gibt zurück
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
Aktualisieren Sie vorhandene Produktdetails.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>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.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.
- parameters
- ProductUpdateParameters
Parameter aktualisieren.
- options
- ProductUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<ProductUpdateResponse>