Api Management Service - Backup

Service:

API Management

API Version:

2022-08-01

Biztonsági másolatot készít a API Management szolgáltatásról az adott Azure Storage-fiókba. Ez a művelet hosszú ideig fut, és eltarthat néhány percig.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string	A API Management szolgáltatás neve. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
backupName	True	string	A létrehozandó/lekérendő biztonsági mentési fájl neve.
containerName	True	string	A blobtároló neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).
storageAccount	True	string	Az Azure Storage-fiók neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).
accessKey		string	Tárfiók hozzáférési kulcsa. Csak akkor szükséges, ha accessType a AccessKeyértéke .
accessType		AccessType	A tárfiókhoz használandó hozzáférés típusa.
clientId		string	A felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója. Csak akkor szükséges, ha accessType a UserAssignedManagedIdentityértéke .

Válaszok

Name	Típus	Description
200 OK	ApiManagementServiceResource	Sikerült biztonsági másolatot készíteni a API Management szolgáltatásról a tárfiókba.
202 Accepted		Elfogadva: A hely fejléce tartalmazza azt az URL-címet, ahol a hosszú ideig futó művelet állapota ellenőrizhető. Headers Location: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ApiManagementBackupWithAccessKey

ApiManagementBackupWithSystemManagedIdentity

ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

HTTP

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

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.json
     */
    /**
     * Sample code: ApiManagementBackupWithAccessKey.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithAccessKey(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("teststorageaccount")
                    .withContainerName("backupContainer")
                    .withBackupName("apimService1backup_2017_03_19")
                    .withAccessType(AccessType.ACCESS_KEY)
                    .withAccessKey("fakeTokenPlaceholder"),
                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

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_backup_with_access_key.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.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessKey": "**************************************************",
            "accessType": "AccessKey",
            "backupName": "apimService1backup_2017_03_19",
            "containerName": "backupContainer",
            "storageAccount": "teststorageaccount",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.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/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/ApiManagementBackupWithAccessKey.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithAccessKey() {
	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.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessKey:      to.Ptr("**************************************************"),
		AccessType:     to.Ptr(armapimanagement.AccessTypeAccessKey),
		BackupName:     to.Ptr("apimService1backup_2017_03_19"),
		ContainerName:  to.Ptr("backupContainer"),
		StorageAccount: to.Ptr("teststorageaccount"),
	}, 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 		"tag3": to.Ptr("value3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAACXok="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(true),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-eastus-01.regional.azure-api.net"),
	// 				Location: to.Ptr("East US"),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("23.101.138.153")},
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](1),
	// 					},
	// 			}},
	// 			APIVersionConstraint: &armapimanagement.APIVersionConstraint{
	// 				MinAPIVersion: to.Ptr("2019-01-01"),
	// 			},
	// 			CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-18T06:26:20.334Z"); return t}()),
	// 			CustomProperties: map[string]*string{
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("False"),
	// 			},
	// 			DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 			DisableGateway: to.Ptr(false),
	// 			GatewayRegionalURL: to.Ptr("https://apimService1-westus-01.regional.azure-api.net"),
	// 			GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 			HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("apimService1.azure-api.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(true),
	// 					HostName: to.Ptr("gateway1.msitesting.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeManagement),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("mgmt.msitesting.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypePortal),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("portal1.msitesting.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 			}},
	// 			ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 			NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 			PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicIPAddresses: []*string{
	// 				to.Ptr("13.91.32.113")},
	// 				ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 				TargetProvisioningState: to.Ptr(""),
	// 				VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 				PublisherEmail: to.Ptr("apim@autorestsdk.com"),
	// 				PublisherName: to.Ptr("autorestsdk"),
	// 			},
	// 			SKU: &armapimanagement.ServiceSKUProperties{
	// 				Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 				Capacity: to.Ptr[int32](1),
	// 			},
	// 		}
}

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 Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.json
 */
async function apiManagementBackupWithAccessKey() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessKey: "**************************************************",
    accessType: "AccessKey",
    backupName: "apimService1backup_2017_03_19",
    containerName: "backupContainer",
    storageAccount: "teststorageaccount",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    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

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

HTTP

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.json
     */
    /**
     * Sample code: ApiManagementBackupWithSystemManagedIdentity.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithSystemManagedIdentity(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("contosorpstorage")
                    .withContainerName("apim-backups")
                    .withBackupName("backup5")
                    .withAccessType(AccessType.SYSTEM_ASSIGNED_MANAGED_IDENTITY),
                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

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_backup_with_system_managed_identity.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.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessType": "SystemAssignedManagedIdentity",
            "backupName": "backup5",
            "containerName": "apim-backups",
            "storageAccount": "contosorpstorage",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.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/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/ApiManagementBackupWithSystemManagedIdentity.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithSystemManagedIdentity() {
	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.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessType:     to.Ptr(armapimanagement.AccessTypeSystemAssignedManagedIdentity),
		BackupName:     to.Ptr("backup5"),
		ContainerName:  to.Ptr("apim-backups"),
		StorageAccount: to.Ptr("contosorpstorage"),
	}, 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("apimService1"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAQM8o="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-5fb4-4916-95d4-64b306f9d924"),
	// 		TenantID: to.Ptr("00000000-86f1-0000-91ab-2d7cd011db47"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-a154-4830-0000-46a12da1a1e2"),
	// 				PrincipalID: to.Ptr("00000000-a100-4478-0000-d65d98118ba0"),
	// 			},
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-6328-4db2-0000-ab0e3e7806cf"),
	// 				PrincipalID: to.Ptr("00000000-9208-4128-af2d-a10d2af9b5a3"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("Central US EUAP"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-23T16:26:47.863Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("False"),
	// 		},
	// 		DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 		DisableGateway: to.Ptr(false),
	// 		GatewayRegionalURL: to.Ptr("https://apimService1-centraluseuap-01.regional.azure-api.net"),
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 			{
	// 				Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 				CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 				DefaultSSLBinding: to.Ptr(true),
	// 				HostName: to.Ptr("apimService1.azure-api.net"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 		}},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv1),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("52.XXXX.160.66")},
	// 			PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("apimService1@corp.microsoft.com"),
	// 			PublisherName: to.Ptr("MS"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		SystemData: &armapimanagement.SystemData{
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-30T06:24:57.000Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contoso@microsoft.com"),
	// 			LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 		},
	// 	}
}

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 Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.json
 */
async function apiManagementBackupWithSystemManagedIdentity() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessType: "SystemAssignedManagedIdentity",
    backupName: "backup5",
    containerName: "apim-backups",
    storageAccount: "contosorpstorage",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    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

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

HTTP

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json
     */
    /**
     * Sample code: ApiManagementBackupWithUserAssignedManagedIdentity.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithUserAssignedManagedIdentity(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("contosorpstorage")
                    .withContainerName("apim-backups")
                    .withBackupName("backup5")
                    .withAccessType(AccessType.USER_ASSIGNED_MANAGED_IDENTITY)
                    .withClientId("XXXXX-a154-4830-XXXX-46a12da1a1e2"),
                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

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_backup_with_user_assigned_managed_identity.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.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessType": "UserAssignedManagedIdentity",
            "backupName": "backup5",
            "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2",
            "containerName": "apim-backups",
            "storageAccount": "contosorpstorage",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.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/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/ApiManagementBackupWithUserAssignedManagedIdentity.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithUserAssignedManagedIdentity() {
	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.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessType:     to.Ptr(armapimanagement.AccessTypeUserAssignedManagedIdentity),
		BackupName:     to.Ptr("backup5"),
		ClientID:       to.Ptr("XXXXX-a154-4830-XXXX-46a12da1a1e2"),
		ContainerName:  to.Ptr("apim-backups"),
		StorageAccount: to.Ptr("contosorpstorage"),
	}, 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("apimService1"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAQM8o="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-5fb4-4916-95d4-64b306f9d924"),
	// 		TenantID: to.Ptr("00000000-86f1-0000-91ab-2d7cd011db47"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-a154-4830-0000-46a12da1a1e2"),
	// 				PrincipalID: to.Ptr("00000000-a100-4478-0000-d65d98118ba0"),
	// 			},
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-6328-4db2-0000-ab0e3e7806cf"),
	// 				PrincipalID: to.Ptr("00000000-9208-4128-af2d-a10d2af9b5a3"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("Central US EUAP"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-23T16:26:47.863Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("False"),
	// 		},
	// 		DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 		DisableGateway: to.Ptr(false),
	// 		GatewayRegionalURL: to.Ptr("https://apimService1-centraluseuap-01.regional.azure-api.net"),
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 			{
	// 				Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 				CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 				DefaultSSLBinding: to.Ptr(true),
	// 				HostName: to.Ptr("apimService1.azure-api.net"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 		}},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv1),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("52.XXXX.160.66")},
	// 			PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("apimService1@corp.microsoft.com"),
	// 			PublisherName: to.Ptr("MS"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		SystemData: &armapimanagement.SystemData{
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-30T06:24:57.000Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contoso@microsoft.com"),
	// 			LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 		},
	// 	}
}

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 Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json
 */
async function apiManagementBackupWithUserAssignedManagedIdentity() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessType: "UserAssignedManagedIdentity",
    backupName: "backup5",
    clientId: "XXXXX-a154-4830-XXXX-46a12da1a1e2",
    containerName: "apim-backups",
    storageAccount: "contosorpstorage",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    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

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definíciók

Name	Description
AccessType	A tárfiókhoz használandó hozzáférés típusa.
AdditionalLocation	Egy további API Management erőforrás helyének leírása.
ApiManagementServiceBackupRestoreParameters	Egy API Management szolgáltatásművelet biztonsági mentéséhez/visszaállításához megadott paraméterek.
ApiManagementServiceIdentity	Az Api Management szolgáltatás erőforrásának identitástulajdonságai.
ApiManagementServiceResource	Egyetlen API Management szolgáltatáserőforrás a Listában vagy a Válasz lekérése listában.
ApiManagementServiceSkuProperties	API Management szolgáltatáserőforrás termékváltozatának tulajdonságai.
ApimIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
ApiVersionConstraint	A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
ArmIdWrapper	ARM-erőforrás-azonosító burkolója
CertificateConfiguration	Nem megbízható köztes és főtanúsítványokból álló tanúsítványkonfiguráció.
CertificateInformation	SSL-tanúsítvány adatai.
CertificateSource	Tanúsítvány forrása.
CertificateStatus	Tanúsítvány állapota.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorFieldContract	Hibamező-szerződés.
ErrorResponse	Hibaválasz.
HostnameConfiguration	Egyéni állomásnév-konfiguráció.
HostnameType	Állomásnév típusa.
NatGatewayState	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
PlatformVersion	A szolgáltatást futtató számítási platform verziója.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolati állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
PublicNetworkAccess	Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
RemotePrivateEndpointConnectionWrapper	Távoli privát végpont kapcsolati erőforrása.
SkuType	A termékváltozat neve.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserIdentityProperties
VirtualNetworkConfiguration	Virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.
VirtualNetworkType	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

AccessType

A tárfiókhoz használandó hozzáférés típusa.

Name	Típus	Description
AccessKey	string	Használja a hozzáférési kulcsot.
SystemAssignedManagedIdentity	string	Rendszer által hozzárendelt felügyelt identitás használata.
UserAssignedManagedIdentity	string	Felhasználó által hozzárendelt felügyelt identitás használata.

AdditionalLocation

Egy további API Management erőforrás helyének leírása.

Name	Típus	Alapértelmezett érték	Description
disableGateway	boolean	False	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót ezen a további helyen.
gatewayRegionalUrl	string		A régióban található API Management szolgáltatás átjáró URL-címe.
location	string		A további régió helyneve az Azure Data center-régiók között.
natGatewayState	NatGatewayState	Disabled	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
outboundPublicIPAddresses	string[]		A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.
platformVersion	PlatformVersion		A szolgáltatást futtató számítási platform verziója.
privateIPAddresses	string[]		A API Management szolgáltatás privát statikus terheléselosztású IP-címei, amelyek egy belső Virtual Network egy adott további helyen vannak üzembe helyezve. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
publicIPAddresses	string[]		A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei a további helyen. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
publicIpAddressId	string		Nyilvános standard termékváltozatú, V4-alapú IP-cím, amely Virtual Network üzembe helyezett szolgáltatáshoz társítandó a helyen. Csak az Virtual Network-ben üzembe helyezett prémium termékváltozat esetén támogatott.
sku	ApiManagementServiceSkuProperties		A API Management szolgáltatás termékváltozat-tulajdonságai.
virtualNetworkConfiguration	VirtualNetworkConfiguration		A hely virtuális hálózati konfigurációja.
zones	string[]		A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceBackupRestoreParameters

Egy API Management szolgáltatásművelet biztonsági mentéséhez/visszaállításához megadott paraméterek.

Name	Típus	Alapértelmezett érték	Description
accessKey	string		Tárfiók hozzáférési kulcsa. Csak akkor szükséges, ha accessType a AccessKeyértéke .
accessType	AccessType	AccessKey	A tárfiókhoz használandó hozzáférés típusa.
backupName	string		A létrehozandó/lekérendő biztonsági mentési fájl neve.
clientId	string		A felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója. Csak akkor szükséges, ha accessType a UserAssignedManagedIdentityértéke .
containerName	string		A blobtároló neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).
storageAccount	string		Az Azure Storage-fiók neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).

ApiManagementServiceIdentity

Az Api Management szolgáltatás erőforrásának identitástulajdonságai.

Name	Típus	Description
principalId	string	Az identitás egyszerű azonosítója.
tenantId	string	Az identitás ügyfélbérlő-azonosítója.
type	ApimIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities	<string,  UserIdentityProperties>	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Egyetlen API Management szolgáltatáserőforrás a Listában vagy a Válasz lekérése listában.

Name	Típus	Alapértelmezett érték	Description
etag	string		Az erőforrás ETagje.
id	string		Erőforrás-azonosító.
identity	ApiManagementServiceIdentity		Az Api Management szolgáltatás felügyeltszolgáltatás-identitása.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.additionalLocations	AdditionalLocation[]		A API Management szolgáltatás további adatközponti helyei.
properties.apiVersionConstraint	ApiVersionConstraint		A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
properties.certificates	CertificateConfiguration[]		A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A legfeljebb telepíthető támogatott tanúsítványok maximális mérete 10.
properties.createdAtUtc	string		A API Management szolgáltatás létrehozási UTC-dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.customProperties	object		A API Management szolgáltatás egyéni tulajdonságai. A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 letiltja a titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA az összes TLS(1.0, 1.1 és 1.2) esetében. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 letilthatja a TLS 1.1-et. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 letilthatja a TLS 1.0-t egy API Management szolgáltatásban. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 letilthatja a TLS 1.1-et a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 letilthatja a TLS 1.0-t a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 engedélyezhető a HTTP2 protokoll egy API Management szolgáltatásban. Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, az alaphelyzetbe állítja a kihagyott tulajdonságok értékeit az alapértelmezett értékre. A Http2 kivételével az összes beállítás esetében az alapértelmezett érték az, True ha a szolgáltatás 2018. április 1-jén vagy azt megelőzően jött létre, máskülönben False . A Http2-beállítás alapértelmezett értéke a .False A következő titkosítások bármelyikét letilthatja a következő beállításokkalMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Például: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Az alapértelmezett érték számukra.true Megjegyzés: A következő titkosítások nem tilthatók le, mivel belső platformösszetevőkre van szükségük: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl	string		A DEveloper Portál végpontjának URL-címe a API Management szolgáltatásban.
properties.disableGateway	boolean	False	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót a főrégióban.
properties.enableClientCertificate	boolean	False	A tulajdonság csak használati termékváltozat-szolgáltatáshoz használható. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjáró felé irányuló minden egyes kérésen. Ez lehetővé teszi a tanúsítvány hitelesítését is az átjáró házirendjében.
properties.gatewayRegionalUrl	string		Az alapértelmezett régióban található API Management szolgáltatás átjáró URL-címe.
properties.gatewayUrl	string		A API Management szolgáltatás átjáró URL-címe.
properties.hostnameConfigurations	HostnameConfiguration[]		A API Management szolgáltatás egyéni állomásnév-konfigurációja.
properties.managementApiUrl	string		A felügyeleti API-végpont URL-címe a API Management szolgáltatásban.
properties.natGatewayState	NatGatewayState	Disabled	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
properties.notificationSenderEmail	string		Email címet, amelyről az értesítés el lesz küldve.
properties.outboundPublicIPAddresses	string[]		A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.
properties.platformVersion	PlatformVersion		A szolgáltatást ezen a helyen futtató számítási platform verziója.
properties.portalUrl	string		A Publisher portál végpontjának URL-címe a API Management szolgáltatásban.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		A szolgáltatás privát végpontkapcsolatainak listája.
properties.privateIPAddresses	string[]		A API Management szolgáltatás privát statikus terheléselosztású IP-címei az elsődleges régióban, amely belső Virtual Network van üzembe helyezve. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.provisioningState	string		A API Management szolgáltatás jelenlegi kiépítési állapota, amely a következők egyike lehet: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei az elsődleges régióban. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.publicIpAddressId	string		A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatú V4-alapú IP-cím. Csak a fejlesztői és prémium termékváltozatok Virtual Network való üzembe helyezéséhez támogatott.
properties.publicNetworkAccess	PublicNetworkAccess		Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
properties.publisherEmail	string		Közzétevő e-mail címe.
properties.publisherName	string		Közzétevő neve.
properties.restore	boolean	False	Törölje az Api Management Service-t, ha korábban helyreállítható módon törölték. Ha ez a jelző meg van adva, és True (Igaz) értékre van állítva, a rendszer figyelmen kívül hagyja az összes többi tulajdonságot.
properties.scmUrl	string		A API Management szolgáltatás SCM-végpontJÁNAK URL-címe.
properties.targetProvisioningState	string		A szolgáltatáson elindított hosszú ideig futó művelet által megcélzott API Management szolgáltatás kiépítési állapota.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		A API Management szolgáltatás virtuális hálózati konfigurációja.
properties.virtualNetworkType	VirtualNetworkType	None	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.
sku	ApiManagementServiceSkuProperties		A API Management szolgáltatás termékváltozat-tulajdonságai.
systemData	systemData		Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object		Erőforráscímkék.
type	string		API Management erőforrás erőforrástípusa Microsoft.ApiManagement értékre van állítva.
zones	string[]		A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceSkuProperties

API Management szolgáltatáserőforrás termékváltozatának tulajdonságai.

Name	Típus	Description
capacity	integer	A termékváltozat kapacitása (a termékváltozat üzembe helyezett egységeinek száma). A használati termékváltozat kapacitását 0-ként kell megadni.
name	SkuType	A termékváltozat neve.

ApimIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.

Name	Típus	Description
minApiVersion	string	Korlátozza a vezérlősík API-hívásait API Management szolgáltatásra, amelynek verziója megegyezik vagy újabb ennél az értéknél.

ArmIdWrapper

ARM-erőforrás-azonosító burkolója

Name	Típus	Description
id	string

CertificateConfiguration

Nem megbízható köztes és főtanúsítványokból álló tanúsítványkonfiguráció.

Name	Típus	Description
certificate	CertificateInformation	Tanúsítványadatok.
certificatePassword	string	Tanúsítvány jelszava.
encodedCertificate	string	Base64 Kódolású tanúsítvány.
storeName	enum: CertificateAuthority Root	A System.Security.Cryptography.x509certificates.StoreName tanúsítványtároló helye. Csak a root és a CertificateAuthority érvényes hely.

CertificateInformation

SSL-tanúsítvány adatai.

Name	Típus	Description
expiry	string	A tanúsítvány lejárati dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
subject	string	A tanúsítvány tárgya.
thumbprint	string	A tanúsítványhoz tartozó ujjlenyomat.

CertificateSource

Tanúsítvány forrása.

Name	Típus	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Tanúsítvány állapota.

Name	Típus	Description
Completed	string
Failed	string
InProgress	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Hibamező-szerződés.

Name	Típus	Description
code	string	Tulajdonságszintű hibakód.
message	string	A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target	string	Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error.code	string	Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details	ErrorFieldContract[]	Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.
error.message	string	A hiba emberi olvasásra alkalmas ábrázolása.

HostnameConfiguration

Egyéni állomásnév-konfiguráció.

Name	Típus	Alapértelmezett érték	Description
certificate	CertificateInformation		Tanúsítványadatok.
certificatePassword	string		Tanúsítvány jelszava.
certificateSource	CertificateSource		Tanúsítvány forrása.
certificateStatus	CertificateStatus		Tanúsítvány állapota.
defaultSslBinding	boolean	False	Adja meg az igaz értéket a gazdagépnévhez társított tanúsítvány alapértelmezett SSL-tanúsítványként való beállításához. Ha egy ügyfél nem küldi el az SNI-fejlécet, akkor ez lesz az a tanúsítvány, amelyet a rendszer megtámad. A tulajdonság akkor hasznos, ha egy szolgáltatás több egyéni gazdagépnévvel rendelkezik, és el kell döntenie az alapértelmezett SSL-tanúsítványt. A beállítás csak az átjáró állomásnévtípusára van alkalmazva.
encodedCertificate	string		Base64 Kódolású tanúsítvány.
hostName	string		Az Api Management szolgáltatásban konfigurálandó állomásnév.
identityClientId	string		Rendszer- vagy felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója a Azure AD által generált módon, amely get hozzáféréssel rendelkezik az SSL-tanúsítványt tartalmazó keyVaulthoz.
keyVaultId	string		Az SSL-tanúsítványt tartalmazó KeyVault-titkos kód URL-címe. Ha meg van adva a verziót tartalmazó abszolút URL-cím, az SSL-tanúsítvány automatikus frissítése nem fog működni. Ehhez az Api Management szolgáltatást aka.ms/apimmsi kell konfigurálni. A titkos kódnak application/x-pkcs12 típusúnak kell lennie
negotiateClientCertificate	boolean	False	Adja meg az igaz értéket, hogy mindig tárgyalja az ügyféltanúsítványt a gazdagépnéven. Az alapértelmezett érték hamis.
type	HostnameType		Állomásnév típusa.

HostnameType

Állomásnév típusa.

Name	Típus	Description
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

Name	Típus	Description
Disabled	string	A Nat Gateway le van tiltva a szolgáltatásban.
Enabled	string	A Nat Gateway engedélyezve van a szolgáltatáshoz.

PlatformVersion

A szolgáltatást futtató számítási platform verziója.

Name	Típus	Description
mtv1	string	A szolgáltatást több-bérlős V1 platformon futtató platform.
stv1	string	A szolgáltatást egyetlen bérlős V1 platformon futtató platform.
stv2	string	A szolgáltatást egyetlen bérlős V2 platformon futtató platform.
undetermined	string	A platform verziója nem határozható meg, mivel a számítási platform nincs üzembe helyezve.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

Name	Típus	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kapcsolatot a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e.

PublicNetworkAccess

Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"

Name	Típus	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Távoli privát végpont kapcsolati erőforrása.

Name	Típus	Description
id	string	Privát végpont kapcsolati erőforrás-azonosítója
name	string	Privát végpont kapcsolatának neve
properties.groupIds	string[]	Az összes csoportazonosító.
properties.privateEndpoint	ArmIdWrapper	A privát végpont erőforrása.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
properties.provisioningState	string	A privát végpont kapcsolati erőforrásának kiépítési állapota.
type	string	Privát végpont kapcsolati erőforrástípusa

SkuType

A termékváltozat neve.

Name	Típus	Description
Basic	string	Az Api Management alapszintű termékváltozata.
Consumption	string	Az Api Management használati termékváltozata.
Developer	string	Az Api Management fejlesztői termékváltozata.
Isolated	string	Az Api Management izolált termékváltozata.
Premium	string	Az Api Management prémium termékváltozata.
Standard	string	Az Api Management standard termékváltozata.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az az identitás, amely legutóbb módosította az erőforrást.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserIdentityProperties

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfélazonosítója.
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója.

VirtualNetworkConfiguration

Virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.

Name	Típus	Description
subnetResourceId	string	Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója a API Management szolgáltatás üzembe helyezéséhez.
subnetname	string	Az alhálózat neve.
vnetid	string	A virtuális hálózat azonosítója. Ez általában EGY GUID. Alapértelmezés szerint null GUID-t vár.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

Name	Típus	Description
External	string	A szolgáltatás a Virtual Network része, és internetről érhető el.
Internal	string	A szolgáltatás a Virtual Network része, és csak a virtuális hálózatról érhető el.
None	string	A szolgáltatás nem része a Virtual Network.