ProductApi interface
Interface die een ProductApi vertegenwoordigt.
Methoden
| check |
Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de productentiteit. |
| create |
Hiermee voegt u een API toe aan het opgegeven product. |
| delete(string, string, string, string, Product |
Hiermee verwijdert u de opgegeven API uit het opgegeven product. |
| list |
Geeft een verzameling van de API's weer die zijn gekoppeld aan een product. |
Methodedetails
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de productentiteit.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- productId
-
string
Product-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
De optiesparameters.
Retouren
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Hiermee voegt u een API toe aan het opgegeven product.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- productId
-
string
Product-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
De optiesparameters.
Retouren
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Hiermee verwijdert u de opgegeven API uit het opgegeven product.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- productId
-
string
Product-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
- apiId
-
string
API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
- options
- ProductApiDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Geeft een verzameling van de API's weer die zijn gekoppeld aan een product.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management-service.
- productId
-
string
Product-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
De optiesparameters.