Secrets - Create

Ссылка

Служба:: Front Door Service

Версия API:: 2023-05-01

Создает новый секрет в указанном профиле.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}?api-version=2023-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
profileName	path	True	string	Имя профиля Azure Front Door уровня "Стандартный" или Azure Front Door Premium, уникальное в пределах группы ресурсов.
resourceGroupName	path	True	string	Имя группы ресурсов в подписке Azure. Шаблон регулярного выражения: `^[-\w\._]+$`
secretName	path	True	string	Имя секрета в профиле.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 01.05.2023.

Текст запроса

Имя	Тип	Описание
properties.parameters	SecretParameters: UrlSigningKeyParameters ManagedCertificateParameters CustomerCertificateParameters AzureFirstPartyManagedCertificateParameters	объект , содержащий параметры секрета

Ответы

Имя	Тип	Описание
200 OK	Secret	ОК
201 Created	Secret	Создан. Запрос выполнен и создано новое правило доставки.
202 Accepted	Secret	Принято. Запрос принят для обработки, и операция будет выполнена асинхронно. Заголовки location: string
Other Status Codes	AfdErrorResponse	Ответ об ошибке Azure Front Door, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Secrets_Create

Образец запроса

PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1?api-version=2023-05-01

{
  "properties": {
    "parameters": {
      "type": "CustomerCertificate",
      "secretVersion": "abcdef1234578900abcdef1234567890",
      "secretSource": {
        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename"
      },
      "useLatestVersion": false
    }
  }
}


import com.azure.resourcemanager.cdn.fluent.models.SecretInner;
import com.azure.resourcemanager.cdn.models.CustomerCertificateParameters;
import com.azure.resourcemanager.cdn.models.ResourceReference;

/** Samples for Secrets Create. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Secrets_Create.json
     */
    /**
     * Sample code: Secrets_Create.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void secretsCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getSecrets().create("RG", "profile1", "secret1", new SecretInner()
            .withParameters(new CustomerCertificateParameters().withSecretSource(new ResourceReference().withId(
                "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename"))
                .withSecretVersion("fakeTokenPlaceholder").withUseLatestVersion(false)),
            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.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python secrets_create.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.secrets.begin_create(
        resource_group_name="RG",
        profile_name="profile1",
        secret_name="secret1",
        secret={
            "properties": {
                "parameters": {
                    "secretSource": {
                        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename"
                    },
                    "secretVersion": "abcdef1234578900abcdef1234567890",
                    "type": "CustomerCertificate",
                    "useLatestVersion": False,
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Secrets_Create.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 armcdn_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/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Secrets_Create.json
func ExampleSecretsClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSecretsClient().BeginCreate(ctx, "RG", "profile1", "secret1", armcdn.Secret{
		Properties: &armcdn.SecretProperties{
			Parameters: &armcdn.CustomerCertificateParameters{
				Type: to.Ptr(armcdn.SecretTypeCustomerCertificate),
				SecretSource: &armcdn.ResourceReference{
					ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename"),
				},
				SecretVersion:    to.Ptr("abcdef1234578900abcdef1234567890"),
				UseLatestVersion: to.Ptr(false),
			},
		},
	}, 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.Secret = armcdn.Secret{
	// 	Name: to.Ptr("secret1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/secrets"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1"),
	// 	Properties: &armcdn.SecretProperties{
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 		Parameters: &armcdn.CustomerCertificateParameters{
	// 			Type: to.Ptr(armcdn.SecretTypeCustomerCertificate),
	// 			CertificateAuthority: to.Ptr("Symantec"),
	// 			ExpirationDate: to.Ptr("2025-01-01T00:00:00-00:00"),
	// 			SecretSource: &armcdn.ResourceReference{
	// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"),
	// 			},
	// 			SecretVersion: to.Ptr("abcdef1234578900abcdef1234567890"),
	// 			Subject: to.Ptr("*.contoso.com"),
	// 			SubjectAlternativeNames: []*string{
	// 				to.Ptr("foo.contoso.com"),
	// 				to.Ptr("www3.foo.contoso.com")},
	// 				Thumbprint: to.Ptr("ABCDEF1234567890ABCDEF1234567890ABCDEF12"),
	// 				UseLatestVersion: to.Ptr(true),
	// 			},
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Creates a new Secret within the specified profile.
 *
 * @summary Creates a new Secret within the specified profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Secrets_Create.json
 */
async function secretsCreate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const secretName = "secret1";
  const secret = {
    parameters: {
      type: "CustomerCertificate",
      secretSource: {
        id: "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename",
      },
      secretVersion: "abcdef1234578900abcdef1234567890",
      useLatestVersion: false,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.secrets.beginCreateAndWait(
    resourceGroupName,
    profileName,
    secretName,
    secret
  );
  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

Пример ответа

Код состояния:: 200

{
  "name": "secret1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
  "type": "Microsoft.Cdn/profiles/secrets",
  "properties": {
    "parameters": {
      "type": "CustomerCertificate",
      "subject": "*.contoso.com",
      "certificateAuthority": "Symantec",
      "expirationDate": "2025-01-01T00:00:00-00:00",
      "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
      "secretSource": {
        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
      },
      "secretVersion": "abcdef1234578900abcdef1234567890",
      "useLatestVersion": true,
      "subjectAlternativeNames": [
        "foo.contoso.com",
        "www3.foo.contoso.com"
      ]
    },
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Код состояния:: 201

{
  "name": "secret1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
  "type": "Microsoft.Cdn/profiles/secrets",
  "properties": {
    "parameters": {
      "type": "CustomerCertificate",
      "subject": "*.contoso.com",
      "certificateAuthority": "Symantec",
      "expirationDate": "2025-01-01T00:00:00-00:00",
      "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
      "secretSource": {
        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
      },
      "secretVersion": "abcdef1234578900abcdef1234567890",
      "useLatestVersion": true,
      "subjectAlternativeNames": [
        "foo.contoso.com",
        "www3.foo.contoso.com"
      ]
    },
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Код состояния:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2023-05-01

{
  "name": "secret1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
  "type": "Microsoft.Cdn/profiles/secrets",
  "properties": {
    "parameters": {
      "type": "CustomerCertificate",
      "subject": "*.contoso.com",
      "certificateAuthority": "Symantec",
      "expirationDate": "2025-01-01T00:00:00-00:00",
      "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
      "secretSource": {
        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
      },
      "secretVersion": "abcdef1234578900abcdef1234567890",
      "useLatestVersion": true,
      "subjectAlternativeNames": [
        "foo.contoso.com",
        "www3.foo.contoso.com"
      ]
    },
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Определения

Имя	Описание
AfdErrorResponse	Сообщение об ошибке
AfdProvisioningState	Состояние подготовки
AzureFirstPartyManagedCertificateParameters	Управляемый сертификат Azure FirstParty, предоставляемый другими поставщиками ресурсов первой стороны для включения ПРОТОКОЛА HTTPS.
CustomerCertificateParameters	Сертификат клиента, используемый для https
DeploymentStatus
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
IdentityType	Тип удостоверения, создающего или изменяющего ресурсы
ManagedCertificateParameters	Управляемый сертификат, используемый для https
ResourceReference	Ссылка на другой ресурс.
Secret	Понятное сопоставление имени секрета со сведениями, связанными с секретом или секретом.
SecretType	Тип секретного ресурса.
SystemData	Чтение только системных данных
UrlSigningKeyParameters	Параметры ключа подписывания URL-адреса

AfdErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

AfdProvisioningState

Состояние подготовки

Имя	Тип	Описание
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

AzureFirstPartyManagedCertificateParameters

Управляемый сертификат Azure FirstParty, предоставляемый другими поставщиками ресурсов первой стороны для включения ПРОТОКОЛА HTTPS.

Имя	Тип	Описание
certificateAuthority	string	Центр выдачи сертификатов.
expirationDate	string	Дата окончания срока действия сертификата.
secretSource	ResourceReference	Ссылка на ресурс на сертификат Key Vault Azure. Ожидается формат /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject	string	Имя субъекта в сертификате.
subjectAlternativeNames	string[]	Список сетей SAN.
thumbprint	string	Отпечаток сертификата.
type	string: AzureFirstPartyManagedCertificate	Тип секретного ресурса.

CustomerCertificateParameters

Сертификат клиента, используемый для https

Имя	Тип	Описание
certificateAuthority	string	Центр выдачи сертификатов.
expirationDate	string	Дата окончания срока действия сертификата.
secretSource	ResourceReference	Ссылка на ресурс на сертификат Key Vault Azure. Ожидается формат /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
secretVersion	string	Версия используемого секрета
subject	string	Имя субъекта в сертификате.
subjectAlternativeNames	string[]	Список сетей SAN.
thumbprint	string	Отпечаток сертификата.
type	string: CustomerCertificate	Тип секретного ресурса.
useLatestVersion	boolean	Указывает, следует ли использовать последнюю версию сертификата

DeploymentStatus

Имя	Тип	Описание
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

IdentityType

Тип удостоверения, создающего или изменяющего ресурсы

Имя	Тип	Описание
application	string
key	string
managedIdentity	string
user	string

ManagedCertificateParameters

Управляемый сертификат, используемый для https

Имя	Тип	Описание
expirationDate	string	Дата окончания срока действия сертификата.
subject	string	Имя субъекта в сертификате.
type	string: ManagedCertificate	Тип секретного ресурса.

ResourceReference

Ссылка на другой ресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.

Secret

Понятное сопоставление имени секрета со сведениями, связанными с секретом или секретом.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.deploymentStatus	DeploymentStatus
properties.parameters	SecretParameters: AzureFirstPartyManagedCertificateParameters CustomerCertificateParameters ManagedCertificateParameters UrlSigningKeyParameters	объект , содержащий параметры секрета
properties.profileName	string	Имя профиля, в котором хранится секрет.
properties.provisioningState	AfdProvisioningState	Состояние подготовки
systemData	SystemData	Чтение только системных данных
type	string	Тип ресурса.

SecretType

Тип секретного ресурса.

Имя	Тип	Описание
AzureFirstPartyManagedCertificate	string
CustomerCertificate	string
ManagedCertificate	string
UrlSigningKey	string

SystemData

Чтение только системных данных

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC)
createdBy	string	Идентификатор удостоверения, создавшего ресурс.
createdByType	IdentityType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор удостоверения, который последний раз изменял ресурс.
lastModifiedByType	IdentityType	Тип удостоверения, который последний раз изменял ресурс.

UrlSigningKeyParameters

Параметры ключа подписывания URL-адреса

Имя	Тип	Описание
keyId	string	Определяет определенный клиентом идентификатор ключа. Этот идентификатор будет существовать во входящем запросе для указания ключа, используемого для формирования хэша.
secretSource	ResourceReference	Ссылка на ресурс на секрет Key Vault Azure. Ожидается формат /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretVersion	string	Версия используемого секрета
type	string: UrlSigningKey	Тип секретного ресурса.

Поделиться через

Secrets - Create

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Secrets_Create

Образец запроса

Пример ответа

Определения

AfdErrorResponse

AfdProvisioningState

AzureFirstPartyManagedCertificateParameters

CustomerCertificateParameters

DeploymentStatus

ErrorAdditionalInfo

ErrorDetail

IdentityType

ManagedCertificateParameters

ResourceReference

Secret

SecretType

SystemData

UrlSigningKeyParameters

Дополнительные ресурсы