Site Network Services - Create Or Update

Hizmet:

Hybrid Network

API Sürümü:

2023-09-01

Bir ağ sitesi oluşturur veya güncelleştirir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/siteNetworkServices/{siteNetworkServiceName}?api-version=2023-09-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
siteNetworkServiceName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Site ağ hizmetinin adı.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynağın bulunduğu coğrafi konum
identity		ManagedServiceIdentity	Yapılandırıldıysa Site ağ hizmetinin yönetilen kimliği.
properties		SiteNetworkServicePropertiesFormat	Site ağ hizmeti özellikleri.
sku		Sku	Site ağ hizmetinin SKU'su.
tags		object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	SiteNetworkService	Oluşturma veya güncelleştirme işlemi başarıyla tamamlandı. İşlem, sonuçta elde edilen site ağ hizmeti kaynağını döndürür.
201 Created	SiteNetworkService	Oluşturma veya güncelleştirme işlemi başarıyla tamamlandı. İşlem, sonuçta elde edilen site ağ hizmeti kaynağını döndürür.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Create first party site network service

Create site network service

Create first party site network service

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName?api-version=2023-09-01

{
  "location": "westUs2",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "networkServiceDesignVersionResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0",
      "idType": "Secret"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Örnek yanıt

Durum kodu:

200

{
  "name": "testSiteNetworkServiceName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName",
  "type": "Microsoft.HybridNetwork/siteNetworkServices",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "westUs2",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "properties": {
    "provisioningState": "Accepted",
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName",
    "networkServiceDesignVersionName": "1.0.1",
    "networkServiceDesignVersionOfferingLocation": "eastus",
    "networkServiceDesignVersionResourceReference": {
      "idType": "Secret"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Durum kodu:

201

{
  "name": "testSiteNetworkServiceName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName",
  "type": "Microsoft.HybridNetwork/siteNetworkServices",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "westUs2",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "properties": {
    "provisioningState": "Accepted",
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName",
    "networkServiceDesignVersionName": "1.0.1",
    "networkServiceDesignVersionOfferingLocation": "eastus",
    "networkServiceDesignVersionResourceReference": {
      "idType": "Secret"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Create site network service

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName?api-version=2023-09-01

{
  "location": "westUs2",
  "sku": {
    "name": "Standard"
  },
  "properties": {
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "networkServiceDesignVersionResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0",
      "idType": "Open"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Örnek yanıt

Durum kodu:

200

{
  "name": "testSiteNetworkServiceName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName",
  "type": "Microsoft.HybridNetwork/siteNetworkServices",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "westUs2",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "properties": {
    "provisioningState": "Accepted",
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName",
    "networkServiceDesignVersionName": "1.0.1",
    "networkServiceDesignVersionOfferingLocation": "eastus",
    "networkServiceDesignVersionResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1",
      "idType": "Open"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Durum kodu:

201

{
  "name": "testSiteNetworkServiceName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName",
  "type": "Microsoft.HybridNetwork/siteNetworkServices",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "location": "westUs2",
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "properties": {
    "provisioningState": "Accepted",
    "siteReference": {
      "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"
    },
    "publisherName": "testPublisher",
    "publisherScope": "Public",
    "networkServiceDesignGroupName": "testNetworkServiceDesignGroupName",
    "networkServiceDesignVersionName": "1.0.1",
    "networkServiceDesignVersionOfferingLocation": "eastus",
    "networkServiceDesignVersionResourceReference": {
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1",
      "idType": "Open"
    },
    "desiredStateConfigurationGroupValueReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"
      }
    }
  }
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ManagedResourceGroupConfiguration	Yönetilen kaynak grubu yapılandırması.
ManagedServiceIdentity	Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler)
ManagedServiceIdentityType	Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
OpenDeploymentResourceReference	Gizli dizi olmayan dağıtım kaynak kimliği başvurusu.
ProvisioningState	Geçerli sağlama durumu.
PublisherScope	Yayımcı Kapsamı.
ReferencedResource	Başka bir kaynağa başvuru.
SecretDeploymentResourceReference	Gizli dizi dağıtımı kaynak kimliği başvurusu.
SiteNetworkService	Site ağ hizmeti kaynağı.
SiteNetworkServicePropertiesFormat	Site ağ hizmeti özellikleri.
Sku	Bir SiteNetworkService ile ilişkilendirilecek Sku.
SkuName	Bu Sku'nun adı
SkuTier	SKU adını temel alan SKU katmanı.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserAssignedIdentity	Kullanıcı tarafından atanan kimlik özellikleri

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ManagedResourceGroupConfiguration

Object

Yönetilen kaynak grubu yapılandırması.

Name	Tür	Description
location	string	Yönetilen kaynak grubu konumu.
name	string	Yönetilen kaynak grubu adı.

ManagedServiceIdentity

Object

Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler)

Name	Tür	Description
principalId	string (uuid)	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string (uuid)	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	ManagedServiceIdentityType	Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).
userAssignedIdentities	<string,  UserAssignedIdentity>	kimlikleri User-Assigned Kaynakla ilişkili kullanıcı tarafından atanan kimlik kümesi. userAssignedIdentities sözlük anahtarları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Sözlük değerleri, isteklerdeki boş nesneler ({}) olabilir.

ManagedServiceIdentityType

Listeleme

Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir).

Değer	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OpenDeploymentResourceReference

Object

Gizli dizi olmayan dağıtım kaynak kimliği başvurusu.

Name	Tür	Default value	Description
id	string		Kaynak Kimliği.
idType	string: Open	Open	Kaynak başvurusu arm kimliği türü.

ProvisioningState

Listeleme

Geçerli sağlama durumu.

Değer	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

PublisherScope

Listeleme

Yayımcı Kapsamı.

Değer	Description
Unknown
Private

ReferencedResource

Object

Başka bir kaynağa başvuru.

Name	Tür	Description
id	string	Kaynak Kimliği.

SecretDeploymentResourceReference

Object

Gizli dizi dağıtımı kaynak kimliği başvurusu.

Name	Tür	Default value	Description
id	string		Kaynak Kimliği.
idType	string: Secret	Open	Kaynak başvurusu arm kimliği türü.

SiteNetworkService

Object

Site ağ hizmeti kaynağı.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Yapılandırıldıysa Site ağ hizmetinin yönetilen kimliği.
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties	SiteNetworkServicePropertiesFormat	Site ağ hizmeti özellikleri.
sku	Sku	Site ağ hizmetinin SKU'su.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

SiteNetworkServicePropertiesFormat

Object

Site ağ hizmeti özellikleri.

Name	Tür	Description
desiredStateConfigurationGroupValueReferences	<string,  ReferencedResource>	Site ağ hizmeti kaynağının hedef durumu. Bu, site ağ hizmetinin istenen durumunu açıklayan yapılandırma grubu değer nesnelerine başvurular içerir.
lastStateConfigurationGroupValueReferences	<string,  ReferencedResource>	Site ağ hizmeti kaynağının son durumu.
lastStateNetworkServiceDesignVersionName	string	Site ağ hizmeti için ağ hizmeti tasarım sürümü.
managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	Yönetilen kaynak grubu yapılandırması.
networkServiceDesignGroupName	string	Site ağ hizmetinin ağ hizmeti tasarım grubu adı.
networkServiceDesignVersionName	string	Site ağ hizmeti için ağ hizmeti tasarım sürümü.
networkServiceDesignVersionOfferingLocation	string	Ağ hizmeti tasarım teklifinin konumu.
networkServiceDesignVersionResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	Ağ hizmeti tasarım sürümü kaynak başvurusu.
provisioningState	ProvisioningState	Site ağ hizmeti kaynağının sağlama durumu.
publisherName	string	Site ağ hizmetinin yayımcı adı.
publisherScope	PublisherScope	Yayımcının kapsamı.
siteReference	ReferencedResource	Site ayrıntıları

Sku

Object

Bir SiteNetworkService ile ilişkilendirilecek Sku.

Name	Tür	Description
name	SkuName	Bu Sku'nun adı
tier	SkuTier	SKU adını temel alan SKU katmanı.

SkuName

Listeleme

Bu Sku'nun adı

Değer	Description
Basic
Standard

SkuTier

Listeleme

SKU adını temel alan SKU katmanı.

Değer	Description
Basic
Standard

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

UserAssignedIdentity

Object

Kullanıcı tarafından atanan kimlik özellikleri

Name	Tür	Description
clientId	string (uuid)	Atanan kimliğin istemci kimliği.
principalId	string (uuid)	Atanan kimliğin asıl kimliği.