Named Value - Refresh Secret

Referenz

Dienst:: API Management

API-Version:: 2022-08-01

Aktualisieren Sie das Geheimnis des benannten Werts, der durch den Bezeichner angegeben wird.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}/refreshSecret?api-version=2022-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namedValueId	path	True	string	Bezeichner des NamedValue. RegEx-Muster: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name

Typ

Beschreibung

200 OK

NamedValueContract

Der benannte Wert wurde erfolgreich aktualisiert.

Header

ETag: string

202 Accepted

Die Anforderung zur Aktualisierung des Geheimnisses wurde akzeptiert.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementRefreshNamedValue

Beispielanforderung

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2/refreshSecret?api-version=2022-08-01

/** Samples for NamedValue RefreshSecret. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementRefreshNamedValue.json
     */
    /**
     * Sample code: ApiManagementRefreshNamedValue.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementRefreshNamedValue(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.namedValues().refreshSecret("rg1", "apimService1", "testprop2", com.azure.core.util.Context.NONE);
    }
}

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

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_refresh_named_value.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.named_value.begin_refresh_secret(
        resource_group_name="rg1",
        service_name="apimService1",
        named_value_id="testprop2",
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementRefreshNamedValue.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

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementRefreshNamedValue.json
func ExampleNamedValueClient_BeginRefreshSecret() {
	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)
	}
	poller, err := clientFactory.NewNamedValueClient().BeginRefreshSecret(ctx, "rg1", "apimService1", "testprop2", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.NamedValueContract = armapimanagement.NamedValueContract{
	// 	Name: to.Ptr("testprop6"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/namedValues"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6"),
	// 	Properties: &armapimanagement.NamedValueContractProperties{
	// 		Secret: to.Ptr(true),
	// 		Tags: []*string{
	// 			to.Ptr("foo"),
	// 			to.Ptr("bar")},
	// 			DisplayName: to.Ptr("prop6namekv"),
	// 			KeyVault: &armapimanagement.KeyVaultContractProperties{
	// 				IdentityClientID: to.Ptr("2d2df842-44d8-4885-8dec-77cc1a984a31"),
	// 				SecretIdentifier: to.Ptr("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
	// 				LastStatus: &armapimanagement.KeyVaultLastAccessStatusContractProperties{
	// 					Code: to.Ptr("Success"),
	// 					TimeStampUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-11T00:54:31.802Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Refresh the secret of the named value specified by its identifier.
 *
 * @summary Refresh the secret of the named value specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementRefreshNamedValue.json
 */
async function apiManagementRefreshNamedValue() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const namedValueId = "testprop2";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.namedValue.beginRefreshSecretAndWait(
    resourceGroupName,
    serviceName,
    namedValueId
  );
  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

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementRefreshNamedValue.json
// this example is just showing the usage of "NamedValue_RefreshSecret" 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 ApiManagementNamedValueResource created on azure
// for more information of creating ApiManagementNamedValueResource, please refer to the document of ApiManagementNamedValueResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string namedValueId = "testprop2";
ResourceIdentifier apiManagementNamedValueResourceId = ApiManagementNamedValueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, namedValueId);
ApiManagementNamedValueResource apiManagementNamedValue = client.GetApiManagementNamedValueResource(apiManagementNamedValueResourceId);

// invoke the operation
ArmOperation<ApiManagementNamedValueResource> lro = await apiManagementNamedValue.RefreshSecretAsync(WaitUntil.Completed);
ApiManagementNamedValueResource result = lro.Value;

// 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
ApiManagementNamedValueData 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

Beispiel für eine Antwort

Statuscode:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
      "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
KeyVaultContractProperties	Details des KeyVault-Vertrags.
KeyVaultLastAccessStatusContractProperties	Geben Sie Vertragsaktualisierungseigenschaften aus.
NamedValueContract	NamedValue-Details.

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

KeyVaultContractProperties

Details des KeyVault-Vertrags.

Name	Typ	Beschreibung
identityClientId	string	Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird.
lastStatus	KeyVaultLastAccessStatusContractProperties	Das letzte Mal status des Geheimnisses aus dem Schlüsseltresor synchronisieren und aktualisieren.
secretIdentifier	string	Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines geheimen Schlüssels mit Versionsangabe verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden.

KeyVaultLastAccessStatusContractProperties

Geben Sie Vertragsaktualisierungseigenschaften aus.

Name	Typ	Beschreibung
code	string	Letzter status Code für die Synchronisierung und Aktualisierung des Geheimnisses aus dem Schlüsseltresor.
message	string	Details des Fehlers sonst leer.
timeStampUtc	string	Beim letzten Zugriff auf das Geheimnis. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.

NamedValueContract

NamedValue-Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.displayName	string	Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten.
properties.keyVault	KeyVaultContractProperties	Details zum KeyVault-Speicherort des namedValue-Werts.
properties.secret	boolean	Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.
properties.tags	string[]	Optionale Tags, die bei Angabe verwendet werden können, um die NamedValue-Liste zu filtern.
properties.value	string	Wert von NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"