Product - Update

Service:

API Management

API-versie:

2021-08-01

Bestaande productgegevens bijwerken.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2021-08-01

URI-parameters

Name	In	Vereist	Type	Description
productId	path	True	string	Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.approvalRequired	boolean	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.description	string	Productbeschrijving. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Productnaam.
properties.state	ProductState	of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
properties.subscriptionRequired	boolean	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is.
properties.subscriptionsLimit	integer	Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.terms	string	Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

Antwoorden

Name	Type	Description
200 OK	ProductContract	Het product is bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateProduct

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct?api-version=2021-08-01


{
  "properties": {
    "displayName": "Test Template ProductName 4"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.ProductContract;

/** Samples for Product Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
     */
    /**
     * Sample code: ApiManagementUpdateProduct.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateProduct(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ProductContract resource =
            manager.products().getWithResponse("rg1", "apimService1", "testproduct", Context.NONE).getValue();
        resource.update().withDisplayName("Test Template ProductName 4").withIfMatch("*").apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_product.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.product.update(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="testproduct",
        if_match="*",
        parameters={"properties": {"displayName": "Test Template ProductName 4"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
func ExampleProductClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProductClient().Update(ctx, "rg1", "apimService1", "testproduct", "*", armapimanagement.ProductUpdateParameters{
		Properties: &armapimanagement.ProductUpdateProperties{
			DisplayName: to.Ptr("Test Template ProductName 4"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProductContract = armapimanagement.ProductContract{
	// 	Name: to.Ptr("testproduct"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/products"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct"),
	// 	Properties: &armapimanagement.ProductContractProperties{
	// 		Description: to.Ptr("Subscribers have completely unlimited access to the API. Administrator approval is required."),
	// 		ApprovalRequired: to.Ptr(true),
	// 		State: to.Ptr(armapimanagement.ProductStatePublished),
	// 		SubscriptionRequired: to.Ptr(true),
	// 		SubscriptionsLimit: to.Ptr[int32](1),
	// 		DisplayName: to.Ptr("Test Template ProductName 4"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update existing product details.
 *
 * @summary Update existing product details.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
 */
async function apiManagementUpdateProduct() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "testproduct";
  const ifMatch = "*";
  const parameters = {
    displayName: "Test Template ProductName 4",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.product.update(
    resourceGroupName,
    serviceName,
    productId,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateProduct.json
// this example is just showing the usage of "Product_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementProductResource created on azure
// for more information of creating ApiManagementProductResource, please refer to the document of ApiManagementProductResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string productId = "testproduct";
ResourceIdentifier apiManagementProductResourceId = ApiManagementProductResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, productId);
ApiManagementProductResource apiManagementProduct = client.GetApiManagementProductResource(apiManagementProductResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementProductPatch patch = new ApiManagementProductPatch()
{
    DisplayName = "Test Template ProductName 4",
};
ApiManagementProductResource result = await apiManagementProduct.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementProductData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "testproduct",
  "properties": {
    "displayName": "Test Template ProductName 4",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definities

Name	Description
ErrorFieldContract	Fout veldcontract.
ErrorResponse	Foutreactie.
ProductContract	Productdetails.
ProductState	of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
ProductUpdateParameters	Parameters voor productupdates.

ErrorFieldContract

Fout veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.

ProductContract

Productdetails.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.approvalRequired	boolean	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.description	string	Productbeschrijving. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Productnaam.
properties.state	ProductState	of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
properties.subscriptionRequired	boolean	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is.
properties.subscriptionsLimit	integer	Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.terms	string	Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ProductState

of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.

Name	Type	Description
notPublished	string
published	string

ProductUpdateParameters

Parameters voor productupdates.

Name	Type	Description
properties.approvalRequired	boolean	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.description	string	Productbeschrijving. Kan HTML-opmaaktags bevatten.
properties.displayName	string	Productnaam.
properties.state	ProductState	of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
properties.subscriptionRequired	boolean	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is.
properties.subscriptionsLimit	integer	Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
properties.terms	string	Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.