Site Network Services - Create Or Update

Tjänst:

Hybrid Network

API-version:

2023-09-01

Skapar eller uppdaterar en nätverksplats.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
siteNetworkServiceName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Namnet på platsnätverkstjänsten.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
identity		ManagedServiceIdentity	Den hanterade identiteten för platsnätverkstjänsten, om den är konfigurerad.
properties		SiteNetworkServicePropertiesFormat	Egenskaper för platsnätverkstjänsten.
sku		Sku	Sku för platsnätverkstjänsten.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	SiteNetworkService	Åtgärden skapa eller uppdatera har slutförts. Åtgärden returnerar den resulterande platsnätverkstjänstresursen.
201 Created	SiteNetworkService	Åtgärden skapa eller uppdatera har slutförts. Åtgärden returnerar den resulterande platsnätverkstjänstresursen.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create first party site network service

Create site network service

Create first party site network service

Exempelbegäran

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"
      }
    }
  }
}

Exempelsvar

Statuskod:

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"
      }
    }
  }
}

Statuskod:

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

Exempelbegäran

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"
      }
    }
  }
}

Exempelsvar

Statuskod:

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"
      }
    }
  }
}

Statuskod:

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"
      }
    }
  }
}

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ManagedResourceGroupConfiguration	Konfiguration av hanterad resursgrupp.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
OpenDeploymentResourceReference	Resurs-ID-referens för icke-hemlig distribution.
ProvisioningState	Det aktuella etableringstillståndet.
PublisherScope	Utgivaromfång.
ReferencedResource	Referens till en annan resurs.
SecretDeploymentResourceReference	Referens för resurs-ID för hemlig distribution.
SiteNetworkService	Platsnätverkstjänstresurs.
SiteNetworkServicePropertiesFormat	Egenskaper för platsnätverkstjänsten.
Sku	Sku, som ska associeras med en SiteNetworkService.
SkuName	Namnet på den här SKU:n
SkuTier	SKU-nivån baserat på SKU-namnet.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ManagedResourceGroupConfiguration

Objekt

Konfiguration av hanterad resursgrupp.

Name	Typ	Description
location	string	Plats för hanterad resursgrupp.
name	string	Namn på hanterad resursgrupp.

ManagedServiceIdentity

Objekt

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Uppräkning

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OpenDeploymentResourceReference

Objekt

Resurs-ID-referens för icke-hemlig distribution.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID.
idType	string: Open	Open	Resursreferensens arm-ID-typ.

ProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

PublisherScope

Uppräkning

Utgivaromfång.

Värde	Description
Unknown
Private

ReferencedResource

Objekt

Referens till en annan resurs.

Name	Typ	Description
id	string	Resurs-ID.

SecretDeploymentResourceReference

Objekt

Referens för resurs-ID för hemlig distribution.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID.
idType	string: Secret	Open	Resursreferensens arm-ID-typ.

SiteNetworkService

Objekt

Platsnätverkstjänstresurs.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Den hanterade identiteten för platsnätverkstjänsten, om den är konfigurerad.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties	SiteNetworkServicePropertiesFormat	Egenskaper för platsnätverkstjänsten.
sku	Sku	Sku för platsnätverkstjänsten.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SiteNetworkServicePropertiesFormat

Objekt

Egenskaper för platsnätverkstjänsten.

Name	Typ	Description
desiredStateConfigurationGroupValueReferences	<string,  ReferencedResource>	Måltillståndet för platsnätverkstjänstresursen. Detta har referenser till konfigurationsgruppens värdeobjekt som beskriver det önskade tillståndet för platsnätverkstjänsten.
lastStateConfigurationGroupValueReferences	<string,  ReferencedResource>	Det sista tillståndet för platsnätverkstjänstresursen.
lastStateNetworkServiceDesignVersionName	string	Nätverkstjänstens designversion för platsnätverkstjänsten.
managedResourceGroupConfiguration	ManagedResourceGroupConfiguration	Konfiguration av hanterad resursgrupp.
networkServiceDesignGroupName	string	Namn på nätverkstjänstdesigngrupp för platsnätverkstjänsten.
networkServiceDesignVersionName	string	Nätverkstjänstens designversion för platsnätverkstjänsten.
networkServiceDesignVersionOfferingLocation	string	Platsen för designerbjudandet för nätverkstjänsten.
networkServiceDesignVersionResourceReference	DeploymentResourceIdReference: OpenDeploymentResourceReference SecretDeploymentResourceReference	Resursreferens för nätverkstjänstens designversion.
provisioningState	ProvisioningState	Etableringstillståndet för platsnätverkstjänstresursen.
publisherName	string	Utgivarnamnet för platsnätverkstjänsten.
publisherScope	PublisherScope	Utgivarens omfång.
siteReference	ReferencedResource	Webbplatsinformationen

Sku

Objekt

Sku, som ska associeras med en SiteNetworkService.

Name	Typ	Description
name	SkuName	Namnet på den här SKU:n
tier	SkuTier	SKU-nivån baserat på SKU-namnet.

SkuName

Uppräkning

Namnet på den här SKU:n

Värde	Description
Basic
Standard

SkuTier

Uppräkning

SKU-nivån baserat på SKU-namnet.

Värde	Description
Basic
Standard

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string (uuid)	Klient-ID för den tilldelade identiteten.
principalId	string (uuid)	Huvud-ID för den tilldelade identiteten.