Namespaces - Create Or Update

Referencia

Szolgáltatás:: Relay

API-verzió:: 2021-11-01

Azure Relay-névtér létrehozása.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}?api-version=2021-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
namespaceName	path	True	string	A névtér neve
resourceGroupName	path	True	string	Az Azure-előfizetésen belüli erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
parameters	RelayNamespace	A névtérerőforrás létrehozásához megadott paraméterek.

Válaszok

Name	Típus	Description
200 OK	RelayNamespace	A névtér létrehozási kérése sikeres volt.
201 Created	RelayNamespace	A névtér létrehozási kérése elfogadva.
Other Status Codes	ErrorResponse	Relay hibaválasz, amely leírja, hogy miért hiúsult meg a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

RelayNamespaceCreate

Mintakérelem

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849?api-version=2021-11-01

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.relay import RelayAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-relay
# USAGE
    python relay_namespace_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 = RelayAPI(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.namespaces.begin_create_or_update(
        resource_group_name="resourcegroup",
        namespace_name="example-RelayNamespace-5849",
        parameters={
            "location": "South Central US",
            "sku": {"name": "Standard", "tier": "Standard"},
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCreate.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 armrelay_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/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCreate.json
func ExampleNamespacesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrelay.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewNamespacesClient().BeginCreateOrUpdate(ctx, "resourcegroup", "example-RelayNamespace-5849", armrelay.Namespace{
		Location: to.Ptr("South Central US"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		SKU: &armrelay.SKU{
			Name: to.Ptr(armrelay.SKUNameStandard),
			Tier: to.Ptr(armrelay.SKUTierStandard),
		},
	}, 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.Namespace = armrelay.Namespace{
	// 	Name: to.Ptr("example-RelayNamespace-5849"),
	// 	Type: to.Ptr("Microsoft.Relay/Namespaces"),
	// 	ID: to.Ptr("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849"),
	// 	Location: to.Ptr("South Central US"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 	},
	// 	Properties: &armrelay.NamespaceProperties{
	// 		MetricID: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ServiceBusEndpoint: to.Ptr("https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"),
	// 	},
	// 	SKU: &armrelay.SKU{
	// 		Name: to.Ptr(armrelay.SKUNameStandard),
	// 		Tier: to.Ptr(armrelay.SKUTierStandard),
	// 	},
	// }
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Relay;
using Azure.ResourceManager.Relay.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/relay/resource-manager/Microsoft.Relay/stable/2021-11-01/examples/NameSpaces/RelayNameSpaceCreate.json
// this example is just showing the usage of "Namespaces_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "resourcegroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this RelayNamespaceResource
RelayNamespaceCollection collection = resourceGroupResource.GetRelayNamespaces();

// invoke the operation
string namespaceName = "example-RelayNamespace-5849";
RelayNamespaceData data = new RelayNamespaceData(new AzureLocation("South Central US"))
{
    Sku = new RelaySku(RelaySkuName.Standard)
    {
        Tier = RelaySkuTier.Standard,
    },
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
ArmOperation<RelayNamespaceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, namespaceName, data);
RelayNamespaceResource 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
RelayNamespaceData 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

Mintaválasz

Állapotkód:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"
  }
}

Állapotkód:: 201

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-5849",
  "name": "example-RelayNamespace-5849",
  "type": "Microsoft.Relay/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Created",
    "metricId": "ffffffff-ffff-ffff-ffff-ffffffffffff:example-Relaynamespace-5849",
    "serviceBusEndpoint": "https://example-RelayNamespace-5849.servicebus.windows-int.net:443/"
  }
}

Definíciók

Name	Description
ConnectionState	A kapcsolat állapotának részletei.
createdByType	Az erőforrást létrehozó identitás típusa.
EndPointProvisioningState	A privát végponti kapcsolat kiépítési állapota.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
PrivateEndpoint	A kapcsolat privát végponti erőforrása.
PrivateEndpointConnection	A privát végponti kapcsolatok listája.
PrivateLinkConnectionStatus	A kapcsolat állapota.
PublicNetworkAccess	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van
RelayNamespace	A névtérerőforrás leírása.
Sku	A névtér termékváltozata.
SkuName	A termékváltozat neve.
SkuTier	A termékváltozat szintje.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ConnectionState

A kapcsolat állapotának részletei.

Name	Típus	Description
description	string	A kapcsolat állapotának leírása.
status	PrivateLinkConnectionStatus	A kapcsolat állapota.

createdByType

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

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

EndPointProvisioningState

A privát végponti kapcsolat kiépítési állapota.

Name	Típus	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

PrivateEndpoint

A kapcsolat privát végponti erőforrása.

Name	Típus	Description
id	string	A privát végpont ARM-azonosítója.

PrivateEndpointConnection

A privát végponti kapcsolatok listája.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.privateEndpoint	PrivateEndpoint	A kapcsolat privát végponti erőforrása.
properties.privateLinkServiceConnectionState	ConnectionState	A kapcsolat állapotának részletei.
properties.provisioningState	EndPointProvisioningState	A privát végponti kapcsolat kiépítési állapota.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai.
type	string	Az erőforrás típusa. Pl. "Microsoft.EventHub/Namespaces" vagy "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

A kapcsolat állapota.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van

Name	Típus	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

RelayNamespace

A névtérerőforrás leírása.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.createdAt	string		A névtér létrehozásának időpontja.
properties.metricId	string		Az Azure Insights-metrikák azonosítója.
properties.privateEndpointConnections	PrivateEndpointConnection[]		A privát végponti kapcsolatok listája.
properties.provisioningState	string		A névtér kiépítési állapota.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Ez határozza meg, hogy a forgalom engedélyezett-e a nyilvános hálózaton keresztül. Alapértelmezés szerint engedélyezve van.
properties.serviceBusEndpoint	string		A Service Bus-műveletek végrehajtásához használható végpont.
properties.status	string		A névtér állapota.
properties.updatedAt	string		A névtér frissítésének időpontja.
sku	Sku		A névtér termékváltozata.
systemData	systemData		Az erőforráshoz kapcsolódó rendszer metaadatai.
tags	object		Erőforráscímkék.
type	string		Erőforrástípus.

Sku

A névtér termékváltozata.

Name	Típus	Description
name	SkuName	A termékváltozat neve.
tier	SkuTier	A termékváltozat szintje.

SkuName

A termékváltozat neve.

Name	Típus	Description
Standard	string

SkuTier

A termékváltozat szintje.

Name	Típus	Description
Standard	string

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 erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Namespaces - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

RelayNamespaceCreate

Mintakérelem

Mintaválasz

Definíciók

ConnectionState

createdByType

EndPointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

RelayNamespace

Sku

SkuName

SkuTier

systemData

További források