Network Service Design Versions - Get

Referenz

Dienst:: Hybrid Network

API-Version:: 2023-09-01

Ruft Informationen zu einer Netzwerkdienstentwurfsversion ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridNetwork/publishers/{publisherName}/networkServiceDesignGroups/{networkServiceDesignGroupName}/networkServiceDesignVersions/{networkServiceDesignVersionName}?api-version=2023-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkServiceDesignGroupName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Der Name der Netzwerkdienstentwurfsgruppe.
networkServiceDesignVersionName	path	True	string maxLength: 64 pattern: ^(0\|[1-9]\d)\.(0\|[1-9]\d)\.(0\|[1-9]\d)(?:-((?:0\|[1-9]\d\|\d[a-zA-Z-][0-9a-zA-Z-])(?:\.(?:0\|[1-9]\d\|\d[a-zA-Z-][0-9a-zA-Z-]))))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$	Der Name der Netzwerkdienstentwurfsversion. Der Name sollte der SemVer 2.0.0-Spezifikation entsprechen: https://semver.org/spec/v2.0.0.html.
publisherName	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$	Der Name des Herausgebers.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	networkServiceDesignVersion	Die Anforderung ist erfolgreich. Der Vorgang gibt die resultierende networkServiceDesignVersion-Ressource zurück.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a network service design version resource

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0?api-version=2023-09-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "TestVersion",
  "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0",
  "type": "Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions",
  "location": "eastus",
  "properties": {
    "versionState": "Active",
    "configurationGroupSchemaReferences": {
      "MyVM_Configuration": {
        "id": "/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"
      }
    },
    "nfvisFromSite": {
      "nfvi1": {
        "name": "{configurationparameter('MyVM_Configuration').nfviNameFromSite}",
        "type": "AzureCore"
      }
    },
    "resourceElementTemplates": [
      {
        "name": "MyVM",
        "type": "ArmResourceDefinition",
        "dependsOnProfile": {
          "installDependsOn": []
        },
        "configuration": {
          "templateType": "ArmTemplate",
          "parameterValues": "{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}",
          "artifactProfile": {
            "artifactStoreReference": {
              "id": "/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1"
            },
            "artifactName": "MyVMArmTemplate",
            "artifactVersion": "1.0.0"
          }
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
ArmResourceDefinitionResourceElementTemplate	Die Armvorlage RE.
ArmResourceDefinitionResourceElementTemplateDetails	Details der Ressourcendefinitionsressourcenelementvorlage für arm.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DependsOnProfile	Hängt von der Profildefinition ab.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
NetworkFunctionDefinitionResourceElementTemplateDetails	Details zur Ressourcenelementvorlage für die Netzwerkfunktionsdefinition.
networkServiceDesignVersion	Netzwerkdienstentwurfsversion.
networkServiceDesignVersionPropertiesFormat	Eigenschaften der Netzwerkdienstentwurfsversion.
NfviDetails	Die nfvi Details.
NSDArtifactProfile	Artefaktprofileigenschaften.
ProvisioningState	Der aktuelle Bereitstellungsstatus.
ReferencedResource	Verweisen auf eine andere Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
templateType	Der Vorlagentyp.
versionState	Der Versionsstatus des Netzwerkdiensts.

ArmResourceDefinitionResourceElementTemplate

Objekt

Die Armvorlage RE.

Name	Typ	Beschreibung
artifactProfile	NSDArtifactProfile	Artefaktprofileigenschaften.
parameterValues	string	Name- und Wertpaare, die die Parameterwerte definieren. Es kann eine wohlgeformte JSON-Zeichenfolge mit Escapezeichen sein.
templateType	templateType	Der Vorlagentyp.

ArmResourceDefinitionResourceElementTemplateDetails

Objekt

Details der Ressourcendefinitionsressourcenelementvorlage für arm.

Name	Typ	Beschreibung
configuration	ArmResourceDefinitionResourceElementTemplate	Der Ressourcenelementvorlagentyp.
dependsOnProfile	DependsOnProfile	Dies hängt vom Profil ab.
name	string	Name der Ressourcenelementvorlage.
type	string: ArmResourceDefinition	Der Ressourcenelementvorlagentyp.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DependsOnProfile

Objekt

Hängt von der Profildefinition ab.

Name	Typ	Beschreibung
installDependsOn	string[]	Abhängigkeit des Anwendungsinstallationsvorgangs.
uninstallDependsOn	string[]	Abhängigkeit des Anwendungslöschvorgangs.
updateDependsOn	string[]	Abhängigkeit des Anwendungsaktualisierungsvorgangs.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NetworkFunctionDefinitionResourceElementTemplateDetails

Objekt

Details zur Ressourcenelementvorlage für die Netzwerkfunktionsdefinition.

Name	Typ	Beschreibung
configuration	ArmResourceDefinitionResourceElementTemplate	Der Ressourcenelementvorlagentyp.
dependsOnProfile	DependsOnProfile	Dies hängt vom Profil ab.
name	string	Name der Ressourcenelementvorlage.
type	string: NetworkFunctionDefinition	Der Ressourcenelementvorlagentyp.